JavaScript SDK
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 theJavaScript Client API Reference documentation.
This document presumes you have a workingNode.js development environment, LTS versions v16, v18 or v20.
npm install --save miniogit clone https://github.com/minio/minio-jscd minio-jsnpm installnpm run buildnpm install -gminio>7.1.0 is shipped with builtin type definition,@types/minio is no longer needed.
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 to80 for HTTP and443 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*asMiniofrom'minio'constminioClient=newMinio.Client({endPoint:'play.min.io',port:9000,useSSL:true,accessKey:'Q3AM3UQ867SPQQA43P2F',secretKey:'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',})This example connects to an object storage server, creates a bucket, and uploads a file to the bucket.It uses the MinIOplay server, a public MinIO cluster located athttps://play.min.io.
Theplay 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 toplay should be considered public and non-protected.
import*asMiniofrom'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 clusterconstminioClient=newMinio.Client({endPoint:'play.min.io',port:9000,useSSL:true,accessKey:'Q3AM3UQ867SPQQA43P2F',secretKey:'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',})// File to uploadconstsourceFile='/tmp/test-file.txt'// Destination bucketconstbucket='js-test-bucket'// Destination object nameconstdestinationObject='my-test-file.txt'// Check if the bucket exists// If it doesn't, create itconstexists=awaitminioClient.bucketExists(bucket)if(exists){console.log('Bucket '+bucket+' exists.')}else{awaitminioClient.makeBucket(bucket,'us-east-1')console.log('Bucket '+bucket+' created in "us-east-1".')}// Set the object metadatavarmetaData={'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 dataawaitminioClient.fPutObject(bucket,destinationObject,sourceFile,metaData)console.log('File '+sourceFile+' uploaded as object '+destinationObject+' in bucket '+bucket)node file-uploader.mjsBucket 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-bucketVerify the object was created withmc:
mc ls play/js-test-bucket[2023-11-10 17:52:20 UTC] 20KiB STANDARD my-test-file.txtThe complete API Reference is available here:
makeBucketlistBucketsbucketExistsremoveBucketlistObjectslistObjectsV2listObjectsV2WithMetadata(Extension)listIncompleteUploadsgetBucketVersioningsetBucketVersioningsetBucketLifecyclegetBucketLifecycleremoveBucketLifecyclegetObjectLockConfigsetObjectLockConfig
getObjectputObjectcopyObjectstatObjectremoveObjectremoveObjectsremoveIncompleteUploadselectObjectContent
getBucketNotificationsetBucketNotificationremoveAllBucketNotificationlistenBucketNotification(MinIO Extension)
- list-buckets.mjs
- list-objects.js
- list-objects-v2.js
- list-objects-v2-with-metadata.js (Extension)
- bucket-exists.mjs
- make-bucket.mjs
- remove-bucket.mjs
- list-incomplete-uploads.js
- get-bucket-versioning.mjs
- set-bucket-versioning.mjs
- set-bucket-tagging.mjs
- get-bucket-versioning.mjs
- set-bucket-versioning.mjs
- set-bucket-tagging.mjs
- get-bucket-tagging.mjs
- remove-bucket-tagging.mjs
- set-bucket-lifecycle.mjs
- get-bucket-lifecycle.mjs
- remove-bucket-lifecycle.mjs
- get-object-lock-config.mjs
- set-object-lock-config.mjs
- set-bucket-replication.mjs
- get-bucket-replication.mjs
- remove-bucket-replication.mjs
- set-bucket-encryption.mjs
- get-bucket-encryption.mjs
- remove-bucket-encryption.mjs
- put-object.js
- get-object.mjs
- copy-object.js
- get-partialobject.mjs
- remove-object.js
- remove-incomplete-upload.js
- stat-object.mjs
- get-object-retention.mjs
- put-object-retention.mjs
- put-object-tagging.mjs
- get-object-tagging.mjs
- remove-object-tagging.mjs
- set-object-legal-hold.mjs
- get-object-legal-hold.mjs
- compose-object.mjs
- select-object-content.mjs
- get-bucket-notification.js
- set-bucket-notification.js
- remove-all-bucket-notification.js
- listen-bucket-notification.js (MinIO Extension)