npmpackage.info

Gathering detailed insights and metrics for minio

Other packages similar to minio

@types/minio

7.1.1

Stub TypeScript definitions entry for minio, which provides its own types definitions

@settlemint/sdk-minio

2.4.0

MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities

@pulumi/minio

0.16.4

A Pulumi package for creating and managing minio cloud resources.

cfe-minio

1.0.2-9.1

S3 Compatible Cloud Storage client

Gathering detailed insights and metrics for minio

minio - 8.0.5 | npmpackage.info

minio

MinIO Client SDK for Javascript

8.0.5

1,051

Apache-2.0

JavaScript

123.63 kB

32,080,315 5.8

Installations

npm install minio

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

^16 || ^18 || >=20

Node Version

20.18.3

NPM Version

10.8.2 Score

94.3

Supply Chain

98.2

Quality

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

6

Total

808

Closed

63

Merged

739

Issues

Open

34

Total

589

Closed

555

Releases

Bugfix Release

8.0.5

Updated on Mar 13, 2025

Bugfix Release

8.0.4

Updated on Jan 24, 2025

Bugfix Release

8.0.3

Updated on Dec 18, 2024

Bugfix Release

8.0.2

Updated on Oct 24, 2024

Bugfix Release

8.0.1

Updated on Jun 21, 2024

Major Refactor Release

8.0.0

Updated on Apr 30, 2024

View All 74 releases

Languages

JavaScript

TypeScript

Shell

JavaScript (54.95%)

TypeScript (45.04%)

Shell (0.02%)

Developer

minio

Download Statistics

Total Downloads

32,080,315

Last Day

16,866

Last Week

291,075

Last Month

1,196,104

Last Year

11,320,319

GitHub Statistics

Apache-2.0 License

1,051 Stars

1,235 Commits

295 Forks

22 Watchers

4 Branches

111 Contributors

Updated on Jun 30, 2025

Bundle Size

502.58 kB

Minified

123.63 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 111 Contributors

Package Meta Information

Latest Version

8.0.5

Package Id

minio@8.0.5

Unpacked Size

2.05 MB

Size

541.49 kB

File Count

123

NPM Version

10.8.2

Node Version

20.18.3

Published on

Mar 13, 2025

Total Downloads

Cumulative downloads

Total Downloads

32,080,315

Last Day

0.9%

16,866

Compared to previous day

Last Week

-5.5%

291,075

Compared to previous week

Last Month

12.9%

1,196,104

Compared to previous month

Last Year

44.1%

11,320,319

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

async block-stream2 browser-or-node buffer-crc32 eventemitter3 fast-xml-parser ipaddr.js lodash mime-types query-string stream-json through2 web-encoding xml2js

Dev Dependencies

MinIO JavaScript Library for Amazon S3 Compatible Cloud Storage

The MinIO JavaScript Client SDK provides high level APIs to access any Amazon S3 compatible object storage server.

This guide will show you how to install the client SDK and execute an example JavaScript program. For a complete list of APIs and examples, please take a look at the JavaScript Client API Reference documentation.

This document presumes you have a working Node.js development environment, LTS versions v16, v18 or v20.

Download from NPM

1npm install --save minio

Download from Source

1git clone https://github.com/minio/minio-js
2cd minio-js
3npm install
4npm run build
5npm install -g

Using with TypeScript

minio>7.1.0 is shipped with builtin type definition, @types/minio is no longer needed.

Initialize MinIO Client

The following parameters are needed to connect to a MinIO object storage server:

Parameter	Description
`endPoint`	Hostname of the object storage service.
`port`	TCP/IP port number. Optional, defaults to `80` for HTTP and `443` for HTTPs.
`accessKey`	Access key (user ID) of an account in the S3 service.
`secretKey`	Secret key (password) of an account in the S3 service.
`useSSL`	Optional, set to 'true' to enable secure (HTTPS) access.

1import * as Minio from 'minio'
2
3const minioClient = new Minio.Client({
4  endPoint: 'play.min.io',
5  port: 9000,
6  useSSL: true,
7  accessKey: 'Q3AM3UQ867SPQQA43P2F',
8  secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
9})

Quick Start Example - File Uploader

This example connects to an object storage server, creates a bucket, and uploads a file to the bucket. It uses the MinIO play server, a public MinIO cluster located at https://play.min.io.

The play server runs the latest stable version of MinIO and may be used for testing and development. The access credentials shown in this example are open to the public. All data uploaded to play should be considered public and non-protected.

file-uploader.mjs

1import * as Minio from 'minio'
2
3// Instantiate the MinIO client with the object store service
4// endpoint and an authorized user's credentials
5// play.min.io is the MinIO public test cluster
6const minioClient = new Minio.Client({
7  endPoint: 'play.min.io',
8  port: 9000,
9  useSSL: true,
10  accessKey: 'Q3AM3UQ867SPQQA43P2F',
11  secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
12})
13
14// File to upload
15const sourceFile = '/tmp/test-file.txt'
16
17// Destination bucket
18const bucket = 'js-test-bucket'
19
20// Destination object name
21const destinationObject = 'my-test-file.txt'
22
23// Check if the bucket exists
24// If it doesn't, create it
25const exists = await minioClient.bucketExists(bucket)
26if (exists) {
27  console.log('Bucket ' + bucket + ' exists.')
28} else {
29  await minioClient.makeBucket(bucket, 'us-east-1')
30  console.log('Bucket ' + bucket + ' created in "us-east-1".')
31}
32
33// Set the object metadata
34var metaData = {
35  'Content-Type': 'text/plain',
36  'X-Amz-Meta-Testing': 1234,
37  example: 5678,
38}
39
40// Upload the file with fPutObject
41// If an object with the same name exists,
42// it is updated with new data
43await minioClient.fPutObject(bucket, destinationObject, sourceFile, metaData)
44console.log('File ' + sourceFile + ' uploaded as object ' + destinationObject + ' in bucket ' + bucket)

Run the File Uploader

1node file-uploader.mjs
2Bucket js-test-bucket created successfully in "us-east-1".
3File /tmp/test-file.txt uploaded successfully as my-test-file.txt to bucket js-test-bucket

Verify the object was created with mc:

mc ls play/js-test-bucket
[2023-11-10 17:52:20 UTC]  20KiB STANDARD my-test-file.txt

API Reference

The complete API Reference is available here:

MinIO JavaScript API Reference

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

getBucketNotification
setBucketNotification
removeAllBucketNotification
listenBucketNotification (MinIO Extension)

Bucket Policy Operations

Examples

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

get-bucket-notification.js
set-bucket-notification.js
remove-all-bucket-notification.js
listen-bucket-notification.js (MinIO Extension)

Bucket Policy Operations

Custom Settings

setAccelerateEndPoint

Explore Further

Contribute

Contributors Guide

GitHub Workflow Status

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

9

Maintained

Determines if the project is "actively maintained".

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/lint.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/minio/minio-js/test.yml/master?enable=pin
Warn: downloadThenRun not pinned by hash: .github/workflows/test.yml:34
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:53
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 2 out of 3 npmCommand dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

Score

5.8

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More