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.
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.');
});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.
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.
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.
$ npm install --save minio
#!/usr/bin/env node
var Minio = require('minio')
// find out your s3 end point here:
// http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
var s3client = new Minio({
url: 'https://<your-s3-endpoint>',
accessKey: 'YOUR-ACCESSKEYID',
secretKey: 'YOUR-SECRETACCESSKEY'
})
s3client.listBuckets(function(e, bucketStream) {
if (e) {
console.log(e)
return
}
bucketStream.on('data', function(obj) {
console.log(obj)
})
bucketStream.on('end', function() {
console.log("End")
})
bucketStream.on('error', function(e) {
console.log("Error", e)
})
})
<!doctype html>
<html>
<body>
<script type="text/javascript" src="<your-cdn>/minio-browser.js"></script>
<script>
var s3Client = new Minio({
url: 'https://<your-s3-endpoint>',
accessKey: 'YOUR-ACCESSKEYID',
secretKey: 'YOUR-SECRETACCESSKEY'
});
s3Client.listBuckets(function(e, bucketStream) {
if (e) {
console.log(e);
return
}
bucketStream.on('data', function(obj) {
console.log(obj)
});
bucketStream.on('end', function() {
console.log("End")
});
bucketStream.on('error', function(e) {
console.log("Error", e)
});
})
</script>
</body>
</html>
listObjects(bucket, {prefix: prefix, recursive: true}) : Stream
listIncompleteUploads(bucket, prefix, recursive: true) : Stream
getPartialObject(bucket, key, offset, length) Stream
putObject(bucket, key, Stream, cb)
removeIncompleteUpload(bucket, key, cb)
presignedGetObject(bucket, key, expires) : String
presignedPutObject(bucket, key, expires) : String
presignedPostPolicy(postPolicy) : Object
FAQs
S3 Compatible Cloud Storage client
The npm package minio receives a total of 149,736 weekly downloads. As such, minio popularity was classified as popular.
We found that minio demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.