As a frontend project, minio/minio-js has picked up 1.1k stars on GitHub (JavaScript). MinIO Client SDK for Javascript
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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
The most recent commit recorded on minio/minio-js was 20 days ago, based on the GitHub push timestamp. The repository has 329 forks — one of the better signals of community interest.
Is minio/minio-js open source?
Yes — minio/minio-js ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/minio/minio-js.
What license does minio/minio-js use?
minio/minio-js is released under the Apache-2.0 license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is minio/minio-js associated with?
GitHub's repository topics for minio/minio-js: "aws-s3", "javascript", "javascript-library", "minio-client", "storage-servers". TopGit's editorial category is Frontend.
Where can I see minio/minio-js in action?
The project maintains a homepage at https://docs.min.io/enterprise/aistor-object-store/developers/minio-drivers/#javascript. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about minio/minio-js?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/minio/minio-js is the definitive source.
Read full README in the tab above.
Still deciding about minio-js?
One click hands the question to an AI along with this page — see what it says about minio-js.
/minio-js
