minio

What is minio?

The MinIO npm package is a client library for interacting with MinIO and Amazon S3 compatible cloud storage services. It allows developers to perform a variety of operations such as uploading, downloading, and managing data in object storage.

What are minio's main functionalities?

Initialize MinIO Client

This code initializes a MinIO client instance with the necessary configuration such as endpoint, port, SSL usage, access key, and secret key.

const Minio = require('minio');

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

Upload an Object

This code uploads a file from the local filesystem to a specified bucket in the MinIO server.

minioClient.fPutObject('my-bucket', 'my-object', '/path/to/file', function(err, etag) {
  if (err) return console.log(err);
  console.log('File uploaded successfully.');
});

Download an Object

This code downloads an object from a specified bucket in the MinIO server to the local filesystem.

minioClient.fGetObject('my-bucket', 'my-object', '/path/to/destination', function(err) {
  if (err) return console.log(err);
  console.log('File downloaded successfully.');
});

List Objects in a Bucket

This code lists all objects in a specified bucket. It uses a stream to handle the data and errors.

var stream = minioClient.listObjects('my-bucket', '', true);
stream.on('data', function(obj) { console.log(obj); });
stream.on('error', function(err) { console.log(err); });

Remove an Object

This code removes a specified object from a bucket in the MinIO server.

minioClient.removeObject('my-bucket', 'my-object', function(err) {
  if (err) return console.log(err);
  console.log('Object removed successfully.');
});

Other packages similar to minio

aws-sdk

The AWS SDK for JavaScript provides a comprehensive set of tools for interacting with Amazon Web Services, including S3. It offers similar functionalities to MinIO for managing object storage, but it is specifically designed for AWS services and has a broader scope covering many other AWS services.

google-cloud-storage

The Google Cloud Storage client library for Node.js allows developers to interact with Google Cloud Storage. It provides similar functionalities to MinIO for managing object storage but is tailored for Google Cloud Platform services.

azure-storage

The Azure Storage SDK for Node.js provides tools for interacting with Azure Blob Storage. It offers similar functionalities to MinIO for managing object storage but is specifically designed for Microsoft Azure services.

README

Minio Javascript (Nodejs) Library for Amazon S3 cloud storage

Install from npm

$ npm install --save minio

Example

#!/usr/bin/env node

var Minio = require('minio')
var Through2 = require('through2')

var s3client = new Minio({
  url: 'https://s3.amazonaws.com',
  accessKey: 'YOUR-ACCESSKEYID',
  secretKey: 'YOUR-SECRETACCESSKEY'
})

var bucketStream = s3client.listBuckets()
bucketStream.pipe(Through2.obj(function(bucket, enc, done) {
  console.log(bucket)
  done()
}))

Documentation

Bucket

makeBucket(bucket, cb)

listBuckets() : Stream

bucketExists(bucket, cb)

removeBucket(bucket, cb)

getBucketACL(bucket, cb)

setBucketACL(bucket, acl, cb)

dropAllIncompleteUploads(bucket, cb)

Object

getObject(bucket, key) Stream

getPartialObject(bucket, key, offset, length) Stream

putObject(bucket, key, Stream, cb)

listObjects(bucket, {prefix: prefix, recursive: true}) : Stream

statObject(bucket, key, cb)

removeObject(bucket, key, cb)

dropIncompleteUpload(bucket, key, cb)

Contribute

Contributors Guide