Package Health Score

89 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version			Vulnerabilities	License Risk
8.0.3	\|	12/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.1	\|	06/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.1.4	\|	04/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.0.0	\|	06/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.0.2	\|	05/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (186,848)

GitHub Stars: 967
Forks: 283
Contributors: 90

Direct Usage Popularity

The npm package minio receives a total of 186,848 downloads a week. As such, we scored minio popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package minio, we found that it has been starred 967 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 90
Funding: No

With more than 10 contributors for the minio repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like minio is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 46
Open PR: 12
Last Release: 4 days ago
Last Commit: 1 month ago

Further analysis of the maintenance status of minio based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that minio demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: ^16 || ^18 || >=20

Age: 10 years
Dependencies: 14 Direct
Versions: 82
Install Size: 2.12 MB
Dist-tags: 1
# of Files: 123
Maintainers: 4
TS Typings: Yes

minio has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use minio?

To help you get started, we've collected the most common ways that minio is being used within popular public projects.

minio / minio-js / examples / remove-incomplete-upload.js View on Github

*     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


  // Note: YOUR-ACCESSKEYID, YOUR-SECRETACCESSKEY, my-bucketname and
  // my-objectname are dummy values, please replace them with original values.

var Minio = require('minio')

var s3Client = new Minio.Client({
  endPoint: 's3.amazonaws.com',
  accessKey: 'YOUR-ACCESSKEYID',
  secretKey: 'YOUR-SECRETACCESSKEY'
})
// Remove a partially uploaded object name my-objectname.
s3Client.removeIncompleteUpload('my-bucketname', 'my-objectname', function(e) {
  if (e) {
    return console.log(e)
  }
  console.log("Success")
})

View more ways to use minio

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

npm install --save minio

Download from Source

git clone https://github.com/minio/minio-js
cd minio-js
npm install
npm run build
npm 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.

import * as Minio from 'minio'

const minioClient = new Minio.Client({
  endPoint: 'play.min.io',
  port: 9000,
  useSSL: true,
  accessKey: 'Q3AM3UQ867SPQQA43P2F',
  secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
})

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

import * as Minio from 'minio'

// Instantiate the MinIO client with the object store service
// endpoint and an authorized user's credentials
// play.min.io is the MinIO public test cluster
const minioClient = new Minio.Client({
  endPoint: 'play.min.io',
  port: 9000,
  useSSL: true,
  accessKey: 'Q3AM3UQ867SPQQA43P2F',
  secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
})

// File to upload
const sourceFile = '/tmp/test-file.txt'

// Destination bucket
const bucket = 'js-test-bucket'

// Destination object name
const destinationObject = 'my-test-file.txt'

// Check if the bucket exists
// If it doesn't, create it
const exists = await minioClient.bucketExists(bucket)
if (exists) {
  console.log('Bucket ' + bucket + ' exists.')
} else {
  await minioClient.makeBucket(bucket, 'us-east-1')
  console.log('Bucket ' + bucket + ' created in "us-east-1".')
}

// Set the object metadata
var metaData = {
  'Content-Type': 'text/plain',
  'X-Amz-Meta-Testing': 1234,
  example: 5678,
}

// Upload the file with fPutObject
// If an object with the same name exists,
// it is updated with new data
await minioClient.fPutObject(bucket, destinationObject, sourceFile, metaData)
console.log('File ' + sourceFile + ' uploaded as object ' + destinationObject + ' in bucket ' + bucket)

Run the File Uploader

node file-uploader.mjs
Bucket js-test-bucket created successfully in "us-east-1".
File /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

minio 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

FAQs

What is minio?

S3 Compatible Cloud Storage client. Visit Snyk Advisor to see a full health score report for minio, including popularity, security, maintenance & community analysis.

Is minio popular?

The npm package minio receives a total of 186,848 weekly downloads. As such, minio popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is minio well maintained?

We found that minio demonstrated a healthy version release cadence and project activity. It has a community of 90 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is minio safe to use?

The npm package minio was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 03:13 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (186,848)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use minio?

MinIO JavaScript Library for Amazon S3 Compatible Cloud Storage

Download from NPM

Download from Source

Using with TypeScript

Initialize MinIO Client

Quick Start Example - File Uploader

file-uploader.mjs

Run the File Uploader

API Reference

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

Bucket Policy Operations

Examples

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

Bucket Policy Operations

Custom Settings

Explore Further

Contribute

minio dependencies

minio development dependencies

FAQs

What is minio?

Is minio popular?

Is minio well maintained?

Is minio safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues