diff --git a/.prettierignore b/.prettierignore
index 001f7907..7078cb9f 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -1,3 +1,5 @@
/dist/
*.md
+!docs/API.md
+!README.md
/.github/workflows/
diff --git a/README.md b/README.md
index 955fb08d..7c9e5014 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,6 @@ This quickstart guide will show you how to install the client SDK and execute an
This document assumes that you have a working [nodejs](http://nodejs.org/) setup in place.
-
## Download from NPM
```sh
@@ -32,26 +31,24 @@ npm install -g
You need five items in order to connect to MinIO object storage server.
-
-| Params | Description |
-| :------- | :------------ |
-| endPoint | URL to object storage service. |
-|port| TCP/IP port number. This input is optional. Default value set to ``80`` for HTTP and ``443`` for HTTPs.|
-| accessKey | Access key is like user ID that uniquely identifies your account. |
-| secretKey | Secret key is the password to your account. |
-|useSSL |Set this value to 'true' to enable secure (HTTPS) access |
-
+| Params | Description |
+| :-------- | :-------------------------------------------------------------------------------------------------- |
+| endPoint | URL to object storage service. |
+| port | TCP/IP port number. This input is optional. Default value set to `80` for HTTP and `443` for HTTPs. |
+| accessKey | Access key is like user ID that uniquely identifies your account. |
+| secretKey | Secret key is the password to your account. |
+| useSSL | Set this value to 'true' to enable secure (HTTPS) access |
```js
var Minio = require('minio')
var minioClient = new Minio.Client({
- endPoint: 'play.min.io',
- port: 9000,
- useSSL: true,
- accessKey: 'Q3AM3UQ867SPQQA43P2F',
- secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG'
-});
+ endPoint: 'play.min.io',
+ port: 9000,
+ useSSL: true,
+ accessKey: 'Q3AM3UQ867SPQQA43P2F',
+ secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
+})
```
## Quick Start Example - File Uploader
@@ -68,33 +65,33 @@ var Minio = require('minio')
// Instantiate the minio client with the endpoint
// and access keys as shown below.
var minioClient = new Minio.Client({
- endPoint: 'play.min.io',
- port: 9000,
- useSSL: true,
- accessKey: 'Q3AM3UQ867SPQQA43P2F',
- secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG'
-});
+ endPoint: 'play.min.io',
+ port: 9000,
+ useSSL: true,
+ accessKey: 'Q3AM3UQ867SPQQA43P2F',
+ secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
+})
// File that needs to be uploaded.
var file = '/tmp/photos-europe.tar'
// Make a bucket called europetrip.
-minioClient.makeBucket('europetrip', 'us-east-1', function(err) {
+minioClient.makeBucket('europetrip', 'us-east-1', function (err) {
+ if (err) return console.log(err)
+
+ console.log('Bucket created successfully in "us-east-1".')
+
+ var metaData = {
+ 'Content-Type': 'application/octet-stream',
+ 'X-Amz-Meta-Testing': 1234,
+ example: 5678,
+ }
+ // Using fPutObject API upload your file to the bucket europetrip.
+ minioClient.fPutObject('europetrip', 'photos-europe.tar', file, metaData, function (err, etag) {
if (err) return console.log(err)
-
- console.log('Bucket created successfully in "us-east-1".')
-
- var metaData = {
- 'Content-Type': 'application/octet-stream',
- 'X-Amz-Meta-Testing': 1234,
- 'example': 5678
- }
- // Using fPutObject API upload your file to the bucket europetrip.
- minioClient.fPutObject('europetrip', 'photos-europe.tar', file, metaData, function(err, etag) {
- if (err) return console.log(err)
- console.log('File uploaded successfully.')
- });
-});
+ console.log('File uploaded successfully.')
+ })
+})
```
#### Run file-uploader
@@ -111,132 +108,137 @@ mc ls play/europetrip/
The full API Reference is available here.
-* [Complete API Reference](https://min.io/docs/minio/linux/developers/javascript/API.html)
+- [Complete API Reference](https://min.io/docs/minio/linux/developers/javascript/API.html)
### API Reference : Bucket Operations
-* [`makeBucket`](https://min.io/docs/minio/linux/developers/javascript/API.html#makeBucket)
-* [`listBuckets`](https://min.io/docs/minio/linux/developers/javascript/API.html#listBuckets)
-* [`bucketExists`](https://min.io/docs/minio/linux/developers/javascript/API.html#bucketExists)
-* [`removeBucket`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeBucket)
-* [`listObjects`](https://min.io/docs/minio/linux/developers/javascript/API.html#listObjects)
-* [`listObjectsV2`](https://min.io/docs/minio/linux/developers/javascript/API.html#listObjectsV2)
-* [`listObjectsV2WithMetadata`](https://min.io/docs/minio/linux/developers/javascript/API.html#listObjectsV2WithMetadata) (Extension)
-* [`listIncompleteUploads`](https://min.io/docs/minio/linux/developers/javascript/API.html#listIncompleteUploads)
-* [`getBucketVersioning`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketVersioning)
-* [`setBucketVersioning`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketVersioning)
-* [`setBucketLifecycle`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketLifecycle)
-* [`getBucketLifecycle`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketLifecycle)
-* [`removeBucketLifecycle`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeBucketLifecycle)
-* [`getObjectLockConfig`](https://min.io/docs/minio/linux/developers/javascript/API.html#getObjectLockConfig)
-* [`setObjectLockConfig`](https://min.io/docs/minio/linux/developers/javascript/API.html#setObjectLockConfig)
+- [`makeBucket`](https://min.io/docs/minio/linux/developers/javascript/API.html#makeBucket)
+- [`listBuckets`](https://min.io/docs/minio/linux/developers/javascript/API.html#listBuckets)
+- [`bucketExists`](https://min.io/docs/minio/linux/developers/javascript/API.html#bucketExists)
+- [`removeBucket`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeBucket)
+- [`listObjects`](https://min.io/docs/minio/linux/developers/javascript/API.html#listObjects)
+- [`listObjectsV2`](https://min.io/docs/minio/linux/developers/javascript/API.html#listObjectsV2)
+- [`listObjectsV2WithMetadata`](https://min.io/docs/minio/linux/developers/javascript/API.html#listObjectsV2WithMetadata) (Extension)
+- [`listIncompleteUploads`](https://min.io/docs/minio/linux/developers/javascript/API.html#listIncompleteUploads)
+- [`getBucketVersioning`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketVersioning)
+- [`setBucketVersioning`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketVersioning)
+- [`setBucketLifecycle`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketLifecycle)
+- [`getBucketLifecycle`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketLifecycle)
+- [`removeBucketLifecycle`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeBucketLifecycle)
+- [`getObjectLockConfig`](https://min.io/docs/minio/linux/developers/javascript/API.html#getObjectLockConfig)
+- [`setObjectLockConfig`](https://min.io/docs/minio/linux/developers/javascript/API.html#setObjectLockConfig)
### API Reference : File Object Operations
-* [`fPutObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#fPutObject)
-* [`fGetObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#fGetObject)
+- [`fPutObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#fPutObject)
+- [`fGetObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#fGetObject)
### API Reference : Object Operations
-* [`getObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#getObject)
-* [`putObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#putObject)
-* [`copyObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#copyObject)
-* [`statObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#statObject)
-* [`removeObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeObject)
-* [`removeObjects`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeObjects)
-* [`removeIncompleteUpload`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeIncompleteUpload)
-* [`selectObjectContent`](https://min.io/docs/minio/linux/developers/javascript/API.html#selectObjectContent)
-
+- [`getObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#getObject)
+- [`putObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#putObject)
+- [`copyObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#copyObject)
+- [`statObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#statObject)
+- [`removeObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeObject)
+- [`removeObjects`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeObjects)
+- [`removeIncompleteUpload`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeIncompleteUpload)
+- [`selectObjectContent`](https://min.io/docs/minio/linux/developers/javascript/API.html#selectObjectContent)
### API Reference : Presigned Operations
-* [`presignedGetObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#presignedGetObject)
-* [`presignedPutObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#presignedPutObject)
-* [`presignedPostPolicy`](https://min.io/docs/minio/linux/developers/javascript/API.html#presignedPostPolicy)
+- [`presignedGetObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#presignedGetObject)
+- [`presignedPutObject`](https://min.io/docs/minio/linux/developers/javascript/API.html#presignedPutObject)
+- [`presignedPostPolicy`](https://min.io/docs/minio/linux/developers/javascript/API.html#presignedPostPolicy)
### API Reference : Bucket Notification Operations
-* [`getBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketNotification)
-* [`setBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketNotification)
-* [`removeAllBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeAllBucketNotification)
-* [`listenBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#listenBucketNotification) (MinIO Extension)
+- [`getBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketNotification)
+- [`setBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketNotification)
+- [`removeAllBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#removeAllBucketNotification)
+- [`listenBucketNotification`](https://min.io/docs/minio/linux/developers/javascript/API.html#listenBucketNotification) (MinIO Extension)
### API Reference : Bucket Policy Operations
-* [`getBucketPolicy`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketPolicy)
-* [`setBucketPolicy`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketPolicy)
-
+- [`getBucketPolicy`](https://min.io/docs/minio/linux/developers/javascript/API.html#getBucketPolicy)
+- [`setBucketPolicy`](https://min.io/docs/minio/linux/developers/javascript/API.html#setBucketPolicy)
## Full Examples
#### Full Examples : Bucket Operations
-* [list-buckets.js](https://github.com/minio/minio-js/blob/master/examples/list-buckets.js)
-* [list-objects.js](https://github.com/minio/minio-js/blob/master/examples/list-objects.js)
-* [list-objects-v2.js](https://github.com/minio/minio-js/blob/master/examples/list-objects-v2.js)
-* [list-objects-v2-with-metadata.js](https://github.com/minio/minio-js/blob/master/examples/list-objects-v2-with-metadata.js) (Extension)
-* [bucket-exists.js](https://github.com/minio/minio-js/blob/master/examples/bucket-exists.js)
-* [make-bucket.js](https://github.com/minio/minio-js/blob/master/examples/make-bucket.js)
-* [remove-bucket.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket.js)
-* [list-incomplete-uploads.js](https://github.com/minio/minio-js/blob/master/examples/list-incomplete-uploads.js)
-* [get-bucket-versioning.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-versioning.js)
-* [set-bucket-versioning.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-versioning.js)
-* [set-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-tagging.js)
-* [get-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-tagging.js)
-* [remove-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-tagging.js)
-* [set-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-lifecycle.js)
-* [get-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-lifecycle.js)
-* [remove-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-lifecycle.js)
-* [get-object-lock-config.js](https://github.com/minio/minio-js/blob/master/examples/get-object-lock-config.js)
-* [set-object-lock-config.js](https://github.com/minio/minio-js/blob/master/examples/set-object-lock-config.js)
-* [set-bucket-replication.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-replication.js)
-* [get-bucket-replication.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-replication.js)
-* [remove-bucket-replication.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-replication.js)
+- [list-buckets.js](https://github.com/minio/minio-js/blob/master/examples/list-buckets.js)
+- [list-objects.js](https://github.com/minio/minio-js/blob/master/examples/list-objects.js)
+- [list-objects-v2.js](https://github.com/minio/minio-js/blob/master/examples/list-objects-v2.js)
+- [list-objects-v2-with-metadata.js](https://github.com/minio/minio-js/blob/master/examples/list-objects-v2-with-metadata.js) (Extension)
+- [bucket-exists.js](https://github.com/minio/minio-js/blob/master/examples/bucket-exists.js)
+- [make-bucket.js](https://github.com/minio/minio-js/blob/master/examples/make-bucket.js)
+- [remove-bucket.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket.js)
+- [list-incomplete-uploads.js](https://github.com/minio/minio-js/blob/master/examples/list-incomplete-uploads.js)
+- [get-bucket-versioning.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-versioning.js)
+- [set-bucket-versioning.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-versioning.js)
+- [set-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-tagging.js)
+- [get-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-tagging.js)
+- [remove-bucket-tagging.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-tagging.js)
+- [set-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-lifecycle.js)
+- [get-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-lifecycle.js)
+- [remove-bucket-lifecycle.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-lifecycle.js)
+- [get-object-lock-config.js](https://github.com/minio/minio-js/blob/master/examples/get-object-lock-config.js)
+- [set-object-lock-config.js](https://github.com/minio/minio-js/blob/master/examples/set-object-lock-config.js)
+- [set-bucket-replication.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-replication.js)
+- [get-bucket-replication.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-replication.js)
+- [remove-bucket-replication.js](https://github.com/minio/minio-js/blob/master/examples/remove-bucket-replication.js)
#### Full Examples : File Object Operations
-* [fput-object.js](https://github.com/minio/minio-js/blob/master/examples/fput-object.js)
-* [fget-object.js](https://github.com/minio/minio-js/blob/master/examples/fget-object.js)
+
+- [fput-object.js](https://github.com/minio/minio-js/blob/master/examples/fput-object.js)
+- [fget-object.js](https://github.com/minio/minio-js/blob/master/examples/fget-object.js)
#### Full Examples : Object Operations
-* [put-object.js](https://github.com/minio/minio-js/blob/master/examples/put-object.js)
-* [get-object.js](https://github.com/minio/minio-js/blob/master/examples/get-object.js)
-* [copy-object.js](https://github.com/minio/minio-js/blob/master/examples/copy-object.js)
-* [get-partialobject.js](https://github.com/minio/minio-js/blob/master/examples/get-partialobject.js)
-* [remove-object.js](https://github.com/minio/minio-js/blob/master/examples/remove-object.js)
-* [remove-incomplete-upload.js](https://github.com/minio/minio-js/blob/master/examples/remove-incomplete-upload.js)
-* [stat-object.js](https://github.com/minio/minio-js/blob/master/examples/stat-object.js)
-* [get-object-retention.js](https://github.com/minio/minio-js/blob/master/examples/get-object-retention.js)
-* [put-object-retention.js](https://github.com/minio/minio-js/blob/master/examples/put-object-retention.js)
-* [put-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/put-object-tagging.js)
-* [get-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/get-object-tagging.js)
-* [remove-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/remove-object-tagging.js)
-* [set-object-legal-hold.js](https://github.com/minio/minio-js/blob/master/examples/set-object-legalhold.js)
-* [get-object-legal-hold.js](https://github.com/minio/minio-js/blob/master/examples/get-object-legal-hold.js)
-* [compose-object.js](https://github.com/minio/minio-js/blob/master/examples/compose-object.js)
-* [select-object-content.js](https://github.com/minio/minio-js/blob/master/examples/select-object-content.js)
+
+- [put-object.js](https://github.com/minio/minio-js/blob/master/examples/put-object.js)
+- [get-object.js](https://github.com/minio/minio-js/blob/master/examples/get-object.js)
+- [copy-object.js](https://github.com/minio/minio-js/blob/master/examples/copy-object.js)
+- [get-partialobject.js](https://github.com/minio/minio-js/blob/master/examples/get-partialobject.js)
+- [remove-object.js](https://github.com/minio/minio-js/blob/master/examples/remove-object.js)
+- [remove-incomplete-upload.js](https://github.com/minio/minio-js/blob/master/examples/remove-incomplete-upload.js)
+- [stat-object.js](https://github.com/minio/minio-js/blob/master/examples/stat-object.js)
+- [get-object-retention.js](https://github.com/minio/minio-js/blob/master/examples/get-object-retention.js)
+- [put-object-retention.js](https://github.com/minio/minio-js/blob/master/examples/put-object-retention.js)
+- [put-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/put-object-tagging.js)
+- [get-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/get-object-tagging.js)
+- [remove-object-tagging.js](https://github.com/minio/minio-js/blob/master/examples/remove-object-tagging.js)
+- [set-object-legal-hold.js](https://github.com/minio/minio-js/blob/master/examples/set-object-legalhold.js)
+- [get-object-legal-hold.js](https://github.com/minio/minio-js/blob/master/examples/get-object-legal-hold.js)
+- [compose-object.js](https://github.com/minio/minio-js/blob/master/examples/compose-object.js)
+- [select-object-content.js](https://github.com/minio/minio-js/blob/master/examples/select-object-content.js)
#### Full Examples : Presigned Operations
-* [presigned-getobject.js](https://github.com/minio/minio-js/blob/master/examples/presigned-getobject.js)
-* [presigned-putobject.js](https://github.com/minio/minio-js/blob/master/examples/presigned-putobject.js)
-* [presigned-postpolicy.js](https://github.com/minio/minio-js/blob/master/examples/presigned-postpolicy.js)
+
+- [presigned-getobject.js](https://github.com/minio/minio-js/blob/master/examples/presigned-getobject.js)
+- [presigned-putobject.js](https://github.com/minio/minio-js/blob/master/examples/presigned-putobject.js)
+- [presigned-postpolicy.js](https://github.com/minio/minio-js/blob/master/examples/presigned-postpolicy.js)
#### Full Examples: Bucket Notification Operations
-* [get-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-notification.js)
-* [set-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-notification.js)
-* [remove-all-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/remove-all-bucket-notification.js)
-* [listen-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/minio/listen-bucket-notification.js) (MinIO Extension)
+
+- [get-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-notification.js)
+- [set-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-notification.js)
+- [remove-all-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/remove-all-bucket-notification.js)
+- [listen-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/minio/listen-bucket-notification.js) (MinIO Extension)
#### Full Examples: Bucket Policy Operations
-* [get-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-policy.js)
-* [set-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-policy.js)
+
+- [get-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-policy.js)
+- [set-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-policy.js)
## Custom Settings
-* [setAccelerateEndPoint](https://github.com/minio/minio-js/blob/master/examples/set-accelerate-end-point.js)
+
+- [setAccelerateEndPoint](https://github.com/minio/minio-js/blob/master/examples/set-accelerate-end-point.js)
## Explore Further
-* [Complete Documentation](https://min.io/docs/minio/kubernetes/upstream/index.html)
-* [MinIO JavaScript Client SDK API Reference](https://min.io/docs/minio/linux/developers/javascript/API.html)
-* [Build your own Shopping App Example- Full Application Example ](https://github.com/minio/minio-js-store-app)
+
+- [Complete Documentation](https://min.io/docs/minio/kubernetes/upstream/index.html)
+- [MinIO JavaScript Client SDK API Reference](https://min.io/docs/minio/linux/developers/javascript/API.html)
+- [Build your own Shopping App Example- Full Application Example ](https://github.com/minio/minio-js-store-app)
## Contribute
diff --git a/docs/API.md b/docs/API.md
index 007c0d9c..cbe588f2 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -8,12 +8,12 @@
var Minio = require('minio')
var minioClient = new Minio.Client({
- endPoint: 'play.min.io',
- port: 9000,
- useSSL: true,
- accessKey: 'Q3AM3UQ867SPQQA43P2F',
- secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG'
-});
+ endPoint: 'play.min.io',
+ port: 9000,
+ useSSL: true,
+ accessKey: 'Q3AM3UQ867SPQQA43P2F',
+ secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
+})
```
## AWS S3
@@ -22,14 +22,14 @@ var minioClient = new Minio.Client({
var Minio = require('minio')
var s3Client = new Minio.Client({
- endPoint: 's3.amazonaws.com',
- accessKey: 'YOUR-ACCESSKEYID',
- secretKey: 'YOUR-SECRETACCESSKEY'
+ endPoint: 's3.amazonaws.com',
+ accessKey: 'YOUR-ACCESSKEYID',
+ secretKey: 'YOUR-SECRETACCESSKEY',
})
```
| Bucket operations | Object operations | Presigned operations | Bucket Policy & Notification operations | Custom Settings | |
-|-------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------|-------------------------------------------------------|-----|
+| ----------------------------------------------------- | --------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------- | --- |
| [`makeBucket`](#makeBucket) | [`getObject`](#getObject) | [`presignedUrl`](#presignedUrl) | [`getBucketNotification`](#getBucketNotification) | [`setS3TransferAccelerate`](#setS3TransferAccelerate) | |
| [`listBuckets`](#listBuckets) | [`getPartialObject`](#getPartialObject) | [`presignedGetObject`](#presignedGetObject) | [`setBucketNotification`](#setBucketNotification) | | |
| [`bucketExists`](#bucketExists) | [`fGetObject`](#fGetObject) | [`presignedPutObject`](#presignedPutObject) | [`removeAllBucketNotification`](#removeAllBucketNotification) | | |
@@ -54,33 +54,34 @@ var s3Client = new Minio.Client({
| [`getBucketReplication`](#getBucketReplication) | | | | | |
| [`removeBucketReplication`](#removeBucketReplication) | | | | | |
-## 1. Constructor
+## 1. Constructor
-### new Minio.Client ({endPoint, port, useSSL, accessKey, secretKey, region, transport, sessionToken, partSize})
-
-| |
-| ---- |
-|``new Minio.Client ({endPoint, port, useSSL, accessKey, secretKey, region, transport, sessionToken, partSize})``|
-|Initializes a new client object.|
-
-__Parameters__
-
-| Param | Type | Description |
-|----------------|----------|--------------------------------------------------------------------------------------------------------------|
-| `endPoint` | _string_ | endPoint is a host name or an IP address. |
-| `port` | _number_ | TCP/IP port number. This input is optional. Default value set to 80 for HTTP and 443 for HTTPs. |
-| `useSSL` | _bool_ | If set to true, https is used instead of http. Default is true. |
-| `accessKey` | _string_ | accessKey is like user-id that uniquely identifies your account. |
-| `secretKey` | _string_ | secretKey is the password to your account. |
-| `sessionToken` | _string_ | Set this value to provide x-amz-security-token (AWS S3 specific). (Optional) |
-| `region` | _string_ | Set this value to override region cache. (Optional) |
-| `transport` | _string_ | Set this value to pass in a custom transport. (Optional) |
-| `partSize` | _number_ | Set this value to override default part size of 64MB for multipart uploads. (Optional) |
-| `pathStyle` | _bool_ | Set this value to override default access behavior (path) for non AWS endpoints. Default is true. (Optional) |
+
+### new Minio.Client ({endPoint, port, useSSL, accessKey, secretKey, region, transport, sessionToken, partSize})
+
+| |
+| -------------------------------------------------------------------------------------------------------------- |
+| `new Minio.Client ({endPoint, port, useSSL, accessKey, secretKey, region, transport, sessionToken, partSize})` |
+| Initializes a new client object. |
+
+**Parameters**
+
+| Param | Type | Description |
+| ---------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `endPoint` | _string_ | endPoint is a host name or an IP address. |
+| `port` | _number_ | TCP/IP port number. This input is optional. Default value set to 80 for HTTP and 443 for HTTPs. |
+| `useSSL` | _bool_ | If set to true, https is used instead of http. Default is true. |
+| `accessKey` | _string_ | accessKey is like user-id that uniquely identifies your account. |
+| `secretKey` | _string_ | secretKey is the password to your account. |
+| `sessionToken` | _string_ | Set this value to provide x-amz-security-token (AWS S3 specific). (Optional) |
+| `region` | _string_ | Set this value to override region cache. (Optional) |
+| `transport` | _string_ | Set this value to pass in a custom transport. (Optional) |
+| `partSize` | _number_ | Set this value to override default part size of 64MB for multipart uploads. (Optional) |
+| `pathStyle` | _bool_ | Set this value to override default access behavior (path) for non AWS endpoints. Default is true. (Optional) |
| `transportAgent` | [Agent](https://nodejs.org/api/http.html#class-httpagent) | Set this value to provide a custom HTTP(s) agent to handle timeouts, TLS handling, and low-level socket configurations. (Optional) |
-__Example__
+**Example**
## Create client for MinIO
@@ -88,12 +89,12 @@ __Example__
var Minio = require('minio')
var minioClient = new Minio.Client({
- endPoint: 'play.min.io',
- port: 9000,
- useSSL: true,
- accessKey: 'Q3AM3UQ867SPQQA43P2F',
- secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG'
-});
+ endPoint: 'play.min.io',
+ port: 9000,
+ useSSL: true,
+ accessKey: 'Q3AM3UQ867SPQQA43P2F',
+ secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
+})
```
## Create client for AWS S3
@@ -102,9 +103,9 @@ var minioClient = new Minio.Client({
var Minio = require('minio')
var s3Client = new Minio.Client({
- endPoint: 's3.amazonaws.com',
- accessKey: 'YOUR-ACCESSKEYID',
- secretKey: 'YOUR-SECRETACCESSKEY'
+ endPoint: 's3.amazonaws.com',
+ accessKey: 'YOUR-ACCESSKEYID',
+ secretKey: 'YOUR-SECRETACCESSKEY',
})
```
@@ -114,10 +115,10 @@ var s3Client = new Minio.Client({
var Minio = require('minio')
var s3Client = new Minio.Client({
- endPoint: 's3.amazonaws.com',
- accessKey: 'YOUR-TEMP-ACCESSKEYID',
- secretKey: 'YOUR-TEMP-SECRETACCESSKEY',
- sessionToken: 'YOUR-TEMP-SESSIONTOKEN'
+ endPoint: 's3.amazonaws.com',
+ accessKey: 'YOUR-TEMP-ACCESSKEYID',
+ secretKey: 'YOUR-TEMP-SECRETACCESSKEY',
+ sessionToken: 'YOUR-TEMP-SESSIONTOKEN',
})
```
@@ -129,106 +130,102 @@ var fs = require('fs')
var https = require('https')
var s3Client = new Minio.Client({
- endPoint: 'play.min.io',
- port: 9000,
- useSSL: true,
- accessKey: 'Q3AM3UQ867SPQQA43P2F',
- secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
- transportAgent: new https.Agent({
- timeout: 10000,
- ca: fs.readFileSync("path/to/ca.cert"),
- cert: fs.readFileSync("path/to/public.cert"),
- key: fs.readFileSync("path/to/secret.key"),
- keepAlive: false,
- })
+ endPoint: 'play.min.io',
+ port: 9000,
+ useSSL: true,
+ accessKey: 'Q3AM3UQ867SPQQA43P2F',
+ secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
+ transportAgent: new https.Agent({
+ timeout: 10000,
+ ca: fs.readFileSync('path/to/ca.cert'),
+ cert: fs.readFileSync('path/to/public.cert'),
+ key: fs.readFileSync('path/to/secret.key'),
+ keepAlive: false,
+ }),
})
```
## 2. Bucket operations
+
### makeBucket(bucketName[, region, makeOpts , callback])
Creates a new bucket.
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `region` | _string_ | Region where the bucket is created. This parameter is optional. Default value is us-east-1. |
| `makeOpts` | _object_ | Options to create a bucket. e.g `{ObjectLocking:true}` (Optional) |
| `callback(err)` | _function_ | Callback function with `err` as the error argument. `err` is null if the bucket is successfully created. If no callback is passed, a `Promise` is returned. |
-__Example__
+**Example**
```js
-minioClient.makeBucket('mybucket', 'us-east-1', function(err) {
+minioClient.makeBucket('mybucket', 'us-east-1', function (err) {
if (err) return console.log('Error creating bucket.', err)
console.log('Bucket created successfully in "us-east-1".')
})
```
-__Example 1__
+**Example 1**
Create a bucket with object locking enabled.
```js
-minioClient.makeBucket('mybucket', 'us-east-1', { ObjectLocking:true }, function(err) {
+minioClient.makeBucket('mybucket', 'us-east-1', { ObjectLocking: true }, function (err) {
if (err) return console.log('Error creating bucket with object lock.', err)
console.log('Bucket created successfully in "us-east-1" and enabled object lock')
})
```
+
### listBuckets([callback])
Lists all buckets.
+**Parameters**
-__Parameters__
-
-
-| Param | Type | Description |
-|---|---|---|
-|`callback(err, bucketStream) ` | _function_ | Callback function with error as the first argument. `bucketStream` is the stream emitting bucket information. If no callback is passed, a `Promise` is returned. |
+| Param | Type | Description |
+| ------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `callback(err, bucketStream) ` | _function_ | Callback function with error as the first argument. `bucketStream` is the stream emitting bucket information. If no callback is passed, a `Promise` is returned. |
bucketStream emits Object with the format:-
| Param | Type | Description |
-|-----------------------|----------|-------------------------------|
+| --------------------- | -------- | ----------------------------- |
| `bucket.name` | _string_ | bucket name |
| `bucket.creationDate` | _Date_ | date when bucket was created. |
-
-
-__Example__
-
+**Example**
```js
-minioClient.listBuckets(function(err, buckets) {
+minioClient.listBuckets(function (err, buckets) {
if (err) return console.log(err)
console.log('buckets :', buckets)
})
```
+
#### bucketExists(bucketName[, callback])
Checks if a bucket exists.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-------------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, exists)` | _function_ | `exists` is a boolean which indicates whether `bucketName` exists or not. `err` is set when an error occurs during the operation. If no callback is passed, a `Promise` is returned. |
-__Example__
-
+**Example**
```js
-minioClient.bucketExists('mybucket', function(err, exists) {
+minioClient.bucketExists('mybucket', function (err, exists) {
if (err) {
return console.log(err)
}
@@ -239,54 +236,52 @@ minioClient.bucketExists('mybucket', function(err, exists) {
```
+
### removeBucket(bucketName[, callback])
Removes a bucket.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-----------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | --------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | `err` is `null` if the bucket is removed successfully. If no callback is passed, a `Promise` is returned. |
-__Example__
-
+**Example**
```js
-minioClient.removeBucket('mybucket', function(err) {
+minioClient.removeBucket('mybucket', function (err) {
if (err) return console.log('unable to remove bucket.')
console.log('Bucket removed successfully.')
})
```
+
### listObjects(bucketName, prefix, recursive [,listOpts])
Lists all objects in a bucket.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------|
+| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `prefix` | _string_ | The prefix of the objects that should be listed (optional, default `''`). |
| `recursive` | _bool_ | `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`). |
| `listOpts` | _object_ | query params to list object which can have `{IncludeVersion: _bool_ }` (optional) |
-__Return Value__
+**Return Value**
-
-| Param | Type | Description |
-| ---- | ---- | ---- |
+| Param | Type | Description |
+| -------- | -------- | ------------------------------------------ |
| `stream` | _Stream_ | Stream emitting the objects in the bucket. |
The object is of the format:
| Param | Type | Description |
-|----------------------|-----------|--------------------------------|
+| -------------------- | --------- | ------------------------------ |
| `obj.name` | _string_ | name of the object. |
| `obj.prefix` | _string_ | name of the object prefix. |
| `obj.size` | _number_ | size of the object. |
@@ -295,95 +290,107 @@ The object is of the format:
| `obj.isDeleteMarker` | _boolean_ | true if it is a delete marker. |
| `obj.lastModified` | _Date_ | modified time stamp. |
-__Example__
-
+**Example**
```js
var data = []
-var stream = minioClient.listObjects('mybucket','', true)
-stream.on('data', function(obj) { data.push(obj) } )
-stream.on("end", function (obj) { console.log(data) })
-stream.on('error', function(err) { console.log(err) } )
+var stream = minioClient.listObjects('mybucket', '', true)
+stream.on('data', function (obj) {
+ data.push(obj)
+})
+stream.on('end', function (obj) {
+ console.log(data)
+})
+stream.on('error', function (err) {
+ console.log(err)
+})
```
-__Example1__
+**Example1**
To get Object versions
```js
var data = []
-var stream = minioClient.listObjects('mybucket','', true, {IncludeVersion:true})
-stream.on('data', function(obj) { data.push(obj) } )
-stream.on("end", function (obj) { console.log(data) })
-stream.on('error', function(err) { console.log(err) } )
+var stream = minioClient.listObjects('mybucket', '', true, { IncludeVersion: true })
+stream.on('data', function (obj) {
+ data.push(obj)
+})
+stream.on('end', function (obj) {
+ console.log(data)
+})
+stream.on('error', function (err) {
+ console.log(err)
+})
```
+
### listObjectsV2(bucketName, prefix, recursive, startAfter)
Lists all objects in a bucket using S3 listing objects V2 API
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------|
+| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `prefix` | _string_ | The prefix of the objects that should be listed (optional, default `''`). |
| `recursive` | _bool_ | `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`). |
| `startAfter` | _string_ | Specifies the object name to start after when listing objects in a bucket. (optional, default `''`). |
-
-__Return Value__
+**Return Value**
| Param | Type | Description |
-|----------|----------|--------------------------------------------|
+| -------- | -------- | ------------------------------------------ |
| `stream` | _Stream_ | Stream emitting the objects in the bucket. |
The object is of the format:
| Param | Type | Description |
-|--------------------|----------|----------------------------|
+| ------------------ | -------- | -------------------------- |
| `obj.name` | _string_ | name of the object. |
| `obj.prefix` | _string_ | name of the object prefix. |
| `obj.size` | _number_ | size of the object. |
| `obj.etag` | _string_ | etag of the object. |
| `obj.lastModified` | _Date_ | modified time stamp. |
-
-__Example__
+**Example**
```js
-var stream = minioClient.listObjectsV2('mybucket','', true,'')
-stream.on('data', function(obj) { console.log(obj) } )
-stream.on('error', function(err) { console.log(err) } )
+var stream = minioClient.listObjectsV2('mybucket', '', true, '')
+stream.on('data', function (obj) {
+ console.log(obj)
+})
+stream.on('error', function (err) {
+ console.log(err)
+})
```
+
### listObjectsV2WithMetadata(bucketName, prefix, recursive, startAfter)
Lists all objects and their metadata in a bucket using S3 listing objects V2 API
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------|
+| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `prefix` | _string_ | The prefix of the objects that should be listed (optional, default `''`). |
| `recursive` | _bool_ | `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`). |
| `startAfter` | _string_ | Specifies the object name to start after when listing objects in a bucket. (optional, default `''`). |
-
-__Return Value__
+**Return Value**
| Param | Type | Description |
-|----------|----------|--------------------------------------------|
+| -------- | -------- | ------------------------------------------ |
| `stream` | _Stream_ | Stream emitting the objects in the bucket. |
The object is of the format:
| Param | Type | Description |
-|--------------------|----------|----------------------------|
+| ------------------ | -------- | -------------------------- |
| `obj.name` | _string_ | name of the object. |
| `obj.prefix` | _string_ | name of the object prefix. |
| `obj.size` | _number_ | size of the object. |
@@ -391,578 +398,595 @@ The object is of the format:
| `obj.lastModified` | _Date_ | modified time stamp. |
| `obj.metadata` | _object_ | metadata of the object. |
-__Example__
-
+**Example**
```js
-var stream = minioClient.extensions.listObjectsV2WithMetadata('mybucket','', true,'')
-stream.on('data', function(obj) { console.log(obj) } )
-stream.on('error', function(err) { console.log(err) } )
+var stream = minioClient.extensions.listObjectsV2WithMetadata('mybucket', '', true, '')
+stream.on('data', function (obj) {
+ console.log(obj)
+})
+stream.on('error', function (err) {
+ console.log(err)
+})
```
+
### listIncompleteUploads(bucketName, prefix, recursive)
Lists partially uploaded objects in a bucket.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------|
+| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `prefix` | _string_ | Prefix of the object names that are partially uploaded. (optional, default `''`) |
| `recursive` | _bool_ | `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`). |
-__Return Value__
-
+**Return Value**
| Param | Type | Description |
-|----------|----------|-------------------------------------------|
+| -------- | -------- | ----------------------------------------- |
| `stream` | _Stream_ | Emits objects of the format listed below: |
| Param | Type | Description |
-|-----------------|-----------|----------------------------------------|
+| --------------- | --------- | -------------------------------------- |
| `part.key` | _string_ | name of the object. |
| `part.uploadId` | _string_ | upload ID of the object. |
| `part.size` | _Integer_ | size of the partially uploaded object. |
-__Example__
-
+**Example**
```js
var Stream = minioClient.listIncompleteUploads('mybucket', '', true)
-Stream.on('data', function(obj) {
+Stream.on('data', function (obj) {
console.log(obj)
})
-Stream.on('end', function() {
+Stream.on('end', function () {
console.log('End')
})
-Stream.on('error', function(err) {
+Stream.on('error', function (err) {
console.log(err)
})
```
+
### getBucketVersioning(bucketName)
Get Versioning state of a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|----------------------|------------|----------------------------------------------------------------------------------------------------------------------------------|
+| -------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, res)` | _function_ | Callback is called with `err` in case of error. `res` is the response object. If no callback is passed, a `Promise` is returned. |
-__Example__
+**Example**
+
```js
-minioClient.getBucketVersioning('bucketname', function (err,res){
+minioClient.getBucketVersioning('bucketname', function (err, res) {
if (err) {
return console.log(err)
}
console.log(res)
- console.log("Success")
+ console.log('Success')
})
```
+
### setBucketVersioning(bucketName, versioningConfig, callback)
Set Versioning state on a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------------|------------|----------------------------------------------------|
+| ------------------ | ---------- | -------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `versioningConfig` | _object_ | Versioning Configuration e.g: `{Status:"Enabled"}` |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-var versioningConfig = {Status:"Enabled"}
-minioClient.setBucketVersioning('bucketname',versioningConfig, function (err){
+var versioningConfig = { Status: 'Enabled' }
+minioClient.setBucketVersioning('bucketname', versioningConfig, function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
-
+
### setBucketReplication(bucketName, replicationConfig, callback)
Set replication config on a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|---------------------|------------|--------------------------------------------------|
+| ------------------- | ---------- | ------------------------------------------------ |
| `bucketName` | _string_ | Name of the bucket. |
| `replicationConfig` | _object_ | replicationConfig Configuration as a JSON Object |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-const arnFromMcCli = "arn:minio:replication::1277fcbe7df0bab76ab0c64cf7c45a0d27e01917ee5f11e913f3478417833660:destination"
+const arnFromMcCli =
+ 'arn:minio:replication::1277fcbe7df0bab76ab0c64cf7c45a0d27e01917ee5f11e913f3478417833660:destination'
var replicationConfig = {
- role:arnFromMcCli,
- rules:[{
- "DeleteMarkerReplication": {
- "Status": "Disabled"
- },
- "DeleteReplication": {
- "Status": [
- ]
- },
- "Destination": {
- "Bucket": "arn:aws:s3:::destination"
- },
- "Priority": "1",
- "Status": "Enabled"
- }]
+ role: arnFromMcCli,
+ rules: [
+ {
+ DeleteMarkerReplication: {
+ Status: 'Disabled',
+ },
+ DeleteReplication: {
+ Status: [],
+ },
+ Destination: {
+ Bucket: 'arn:aws:s3:::destination',
+ },
+ Priority: '1',
+ Status: 'Enabled',
+ },
+ ],
}
-minioClient.setBucketReplication('bucketname',replicationConfig, function (err){
+minioClient.setBucketReplication('bucketname', replicationConfig, function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
-
```
+
### getBucketReplication(bucketName, callback)
Get replication config of a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| ---------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, replicationConfig)` | _function_ | Callback is called with `err` in case of error. else returns the info in`replicationConfig` ,which contains`{role: __string__, rules:__Array__ }`. |
-__Example__
+**Example**
+
```js
-minioClient.getBucketReplication('bucketname', function (err,replicationConfig){
+minioClient.getBucketReplication('bucketname', function (err, replicationConfig) {
if (err) {
return console.log(err)
}
console.log(replicationConfig)
})
-
```
+
### removeBucketReplication(bucketName, callback)
Remove replication config of a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-------------------------------------------------|
+| --------------- | ---------- | ----------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-minioClient.removeBucketReplication('bucketname', function (err,replicationConfig){
+minioClient.removeBucketReplication('bucketname', function (err, replicationConfig) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
-
```
+
### setBucketTagging(bucketName, tags, callback)
Set Tags on a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-----------------------------------------------------------|
+| --------------- | ---------- | --------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `tags` | _object_ | Tags map Configuration e.g: `{:}` |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-minioClient.setBucketTagging('bucketname',tags, function (err){
+minioClient.setBucketTagging('bucketname', tags, function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
+
### removeBucketTagging(bucketName, callback)
Remove Tags on a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-------------------------------------------------|
+| --------------- | ---------- | ----------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-minioClient.removeBucketTagging('bucketname', function (err){
+minioClient.removeBucketTagging('bucketname', function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
+
### getBucketTagging(bucketName, callback)
Remove Tags on a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|---------------------------|------------|-------------------------------------------------|
+| ------------------------- | ---------- | ----------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, tagsList)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-minioClient.getBucketTagging('bucketname', function (err, tagsList){
+minioClient.getBucketTagging('bucketname', function (err, tagsList) {
if (err) {
return console.log(err)
}
- console.log("Success",tagsList)
+ console.log('Success', tagsList)
})
```
-
+
### setBucketLifecycle(bucketName, lifecycleConfig, callback)
Set Lifecycle Configuration on a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-------------------|------------|------------------------------------------------------------------------------------|
+| ----------------- | ---------- | ---------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `lifecycleConfig` | _object_ | Valid Lifecycle Configuration or ( `null` or `''` ) to remove policy configuration |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
-```js
-const lifecycleConfig= {
- Rule: [{
- "ID": "Transition and Expiration Rule",
- "Status": "Enabled",
- "Filter": {
- "Prefix":"",
- },
- "Expiration": {
- "Days": "3650"
- }
- }
- ]
+**Example**
+
+```js
+const lifecycleConfig = {
+ Rule: [
+ {
+ ID: 'Transition and Expiration Rule',
+ Status: 'Enabled',
+ Filter: {
+ Prefix: '',
+ },
+ Expiration: {
+ Days: '3650',
+ },
+ },
+ ],
}
-
-minioClient.setBucketLifecycle('bucketname',lifecycleConfig, function (err) {
+
+minioClient.setBucketLifecycle('bucketname', lifecycleConfig, function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
-
-
+
### getBucketLifecycle(bucketName, callback)
Get Lifecycle Configuration of a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|------------------------------------|------------|---------------------------------------------------------------------------------------------------|
+| ---------------------------------- | ---------- | ------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(error, lifecycleConfig)` | _function_ | Callback is called with `lifecycleConfig` in case of success. Otherwise it is called with `error` |
-__Example__
+**Example**
+
```js
minioClient.getBucketLifecycle('bucketname', function (err, lifecycleConfig) {
if (err) {
- return console.log(err)
+ return console.log(err)
}
- console.log("Success", lifecycleConfig)
+ console.log('Success', lifecycleConfig)
})
```
+
### removeBucketLifecycle(bucketName, callback)
Remove Lifecycle Configuration of a Bucket
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-------------------------------------------------|
+| --------------- | ---------- | ----------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-
minioClient.removeBucketLifecycle('bucketname', function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
-
+
### setObjectLockConfig(bucketName, lockConfig [, callback])
Set Object lock config on a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `bucketName` | _string_ | Name of the bucket. |
| `lockConfig` | _object_ | Lock Configuration can be either `{}` to reset or object with all of the following key/value pairs: `{mode: ["COMPLIANCE"/'GOVERNANCE'], unit: ["Days"/"Years"], validity: }` |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example 1__
+**Example 1**
```js
-s3Client.setObjectLockConfig('my-bucketname', {mode:"COMPLIANCE", unit:'Days', validity:10 }, function (err){
- if (err) {
- return console.log(err)
- }
- console.log("Success")
+s3Client.setObjectLockConfig('my-bucketname', { mode: 'COMPLIANCE', unit: 'Days', validity: 10 }, function (err) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log('Success')
})
```
-__Example 2__
+**Example 2**
To reset/remove object lock config on a bucket.
```js
-s3Client.setObjectLockConfig('my-bucketname', {}, function (err){
-if (err) {
-return console.log(err)
-}
-console.log("Success")
+s3Client.setObjectLockConfig('my-bucketname', {}, function (err) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log('Success')
})
```
-
+
### getObjectLockConfig(bucketName [, callback])
Get Lock config on a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------------------|------------|-------------------------------------------------------------------------------------------|
+| --------------------------- | ---------- | ----------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, lockConfig)` | _function_ | Callback is called with `err` in case of error. else it is called with lock configuration |
-__Example __
+**Example **
Get object lock configuration on a Bucket
```js
-s3Client.getObjectLockConfig('my-bucketname', function (err, lockConfig){
- if (err) {
- return console.log(err)
- }
- console.log(lockConfig)
+s3Client.getObjectLockConfig('my-bucketname', function (err, lockConfig) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log(lockConfig)
})
```
+
### setBucketEncryption(bucketName [,encryptionConfig, callback])
Set encryption configuration on a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `encryptionConfig` | _object_ | Encryption Configuration can be either omitted or `{}` or a valid and supported encryption config. by default: `{Rule:[{ApplyServerSideEncryptionByDefault:{SSEAlgorithm:"AES256"}}]}` is applied. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example __
+**Example **
Set Encryption configuration on a Bucket
```js
-s3Client.setBucketEncryption('my-bucketname', function (err, lockConfig){
- if (err) {
- return console.log(err)
- }
- console.log(lockConfig)
+s3Client.setBucketEncryption('my-bucketname', function (err, lockConfig) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log(lockConfig)
})
```
-__Example 1__
+**Example 1**
Set Encryption configuration on a Bucket with an Algorithm
```js
-s3Client.setBucketEncryption('my-bucketname',{Rule:[{ApplyServerSideEncryptionByDefault:{SSEAlgorithm:"AES256"}}]}, function (err, lockConfig){
+s3Client.setBucketEncryption(
+ 'my-bucketname',
+ { Rule: [{ ApplyServerSideEncryptionByDefault: { SSEAlgorithm: 'AES256' } }] },
+ function (err, lockConfig) {
if (err) {
- return console.log(err)
+ return console.log(err)
}
- console.log("Success")
-})
+ console.log('Success')
+ },
+)
```
+
### getBucketEncryption(bucketName [, callback])
Get encryption configuration of a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|----------------------------|------------|-------------------------------------------------------------------------------------------|
+| -------------------------- | ---------- | ----------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, encConfig)` | _function_ | Callback is called with `err` in case of error. else it is called with lock configuration |
-__Example __
+**Example **
Get Encryption configuration of a Bucket
```js
-s3Client.getBucketEncryption('my-bucketname', function (err, encConfig){
- if (err) {
- return console.log(err)
- }
- console.log(encConfig)
+s3Client.getBucketEncryption('my-bucketname', function (err, encConfig) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log(encConfig)
})
```
+
### removeBucketEncryption(bucketName [, callback])
Remove encryption configuration of a Bucket
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-------------------------------------------------|
+| --------------- | ---------- | ----------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example __
+**Example **
Remove Encryption configuration of a Bucket
```js
-s3Client.removeBucketEncryption('my-bucketname', function (err){
- if (err) {
- return console.log(err)
- }
- console.log("Success")
+s3Client.removeBucketEncryption('my-bucketname', function (err) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log('Success')
})
```
-## 3. Object operations
+## 3. Object operations
+
### getObject(bucketName, objectName, getOpts[, callback])
Downloads an object as a stream.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `getOpts` | _object_ | Version of the object in the form `{versionId:"my-versionId"}`. Default is `{}`. (optional) |
| `callback(err, stream)` | _function_ | Callback is called with `err` in case of error. `stream` is the object content stream. If no callback is passed, a `Promise` is returned. |
-__Return Value__
+**Return Value**
| Param | Type | Description |
-|----------|----------|-------------------------------------|
+| -------- | -------- | ----------------------------------- |
| `stream` | _Stream_ | Stream emitting the object content. |
-__Example__
-
+**Example**
```js
var size = 0
-minioClient.getObject('mybucket', 'photo.jpg', function(err, dataStream) {
+minioClient.getObject('mybucket', 'photo.jpg', function (err, dataStream) {
if (err) {
return console.log(err)
}
- dataStream.on('data', function(chunk) {
+ dataStream.on('data', function (chunk) {
size += chunk.length
})
- dataStream.on('end', function() {
+ dataStream.on('end', function () {
console.log('End. Total size = ' + size)
})
- dataStream.on('error', function(err) {
+ dataStream.on('error', function (err) {
console.log(err)
})
})
```
-__Example__
+**Example**
Get a specific object version.
+
```js
var size = 0
-minioClient.getObject('mybucket', 'photo.jpg', {versionId:"my-versionId"}, function(err, dataStream) {
+minioClient.getObject('mybucket', 'photo.jpg', { versionId: 'my-versionId' }, function (err, dataStream) {
if (err) {
return console.log(err)
}
- dataStream.on('data', function(chunk) {
+ dataStream.on('data', function (chunk) {
size += chunk.length
})
- dataStream.on('end', function() {
+ dataStream.on('end', function () {
console.log('End. Total size = ' + size)
})
- dataStream.on('error', function(err) {
+ dataStream.on('error', function (err) {
console.log(err)
})
})
```
+
### getPartialObject(bucketName, objectName, offset, length, getOpts[, callback])
Downloads the specified range bytes of an object as a stream.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `offset` | _number_ | `offset` of the object from where the stream will start. |
@@ -970,85 +994,90 @@ __Parameters__
| `getOpts` | _object_ | Version of the object in the form `{versionId:'my-versionId'}`. Default is `{}`. (optional) |
| `callback(err, stream)` | _function_ | Callback is called with `err` in case of error. `stream` is the object content stream. If no callback is passed, a `Promise` is returned. |
+**Return Value**
-__Return Value__
-
-| Param | Type | Description |
-| ---- | ---- | ---- |
+| Param | Type | Description |
+| -------- | -------- | ----------------------------------- |
| `stream` | _Stream_ | Stream emitting the object content. |
-__Example__
-
+**Example**
```js
var size = 0
// reads 30 bytes from the offset 10.
-minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30, function(err, dataStream) {
+minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30, function (err, dataStream) {
if (err) {
return console.log(err)
}
- dataStream.on('data', function(chunk) {
+ dataStream.on('data', function (chunk) {
size += chunk.length
})
- dataStream.on('end', function() {
+ dataStream.on('end', function () {
console.log('End. Total size = ' + size)
})
- dataStream.on('error', function(err) {
+ dataStream.on('error', function (err) {
console.log(err)
})
})
```
-__Example__
+
+**Example**
To get a specific version of an object
```js
var versionedObjSize = 0
// reads 30 bytes from the offset 10.
-minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30, {versionId:"my-versionId"}, function(err, dataStream) {
- if (err) {
- return console.log(err)
- }
- dataStream.on('data', function(chunk) {
+minioClient.getPartialObject(
+ 'mybucket',
+ 'photo.jpg',
+ 10,
+ 30,
+ { versionId: 'my-versionId' },
+ function (err, dataStream) {
+ if (err) {
+ return console.log(err)
+ }
+ dataStream.on('data', function (chunk) {
versionedObjSize += chunk.length
- })
- dataStream.on('end', function() {
- console.log('End. Total size = ' + versionedObjSize)
- })
- dataStream.on('error', function(err) {
- console.log(err)
- })
-})
+ })
+ dataStream.on('end', function () {
+ console.log('End. Total size = ' + versionedObjSize)
+ })
+ dataStream.on('error', function (err) {
+ console.log(err)
+ })
+ },
+)
```
-
+
### fGetObject(bucketName, objectName, filePath, getOpts[, callback])
Downloads and saves the object as a file in the local filesystem.
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|----------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | -------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `filePath` | _string_ | Path on the local filesystem to which the object data will be written. |
| `getOpts` | _object_ | Version of the object in the form `{versionId:'my-versionId'}`. Default is `{}`. (optional) |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. If no callback is passed, a `Promise` is returned. |
-__Return Value__
+**Return Value**
| Value | Type | Description |
-|--------|----------|--------------------------------------------------|
+| ------ | -------- | ------------------------------------------------ |
| `err` | _object_ | Error in case of any failures |
| `file` | _file_ | Streamed Output file at the specified `filePath` |
-__Example__
-
+**Example**
```js
var size = 0
-minioClient.fGetObject('mybucket', 'photo.jpg', '/tmp/photo.jpg', function(err) {
+minioClient.fGetObject('mybucket', 'photo.jpg', '/tmp/photo.jpg', function (err) {
if (err) {
return console.log(err)
}
@@ -1056,32 +1085,30 @@ minioClient.fGetObject('mybucket', 'photo.jpg', '/tmp/photo.jpg', function(err)
})
```
-__Example__
+**Example**
To Stream a specific object version into a file.
```js
-minioClient.fGetObject(bucketName, objNameValue, './download/MyImage.jpg', {versionId:"my-versionId"}, function(e) {
+minioClient.fGetObject(bucketName, objNameValue, './download/MyImage.jpg', { versionId: 'my-versionId' }, function (e) {
if (e) {
return console.log(e)
}
console.log('success')
})
-
```
+
### putObject(bucketName, objectName, stream, size, metaData[, callback])
Uploads an object from a stream/Buffer.
-
##### From a stream
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ------------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `stream` | _Stream_ | Readable stream. |
@@ -1089,17 +1116,15 @@ __Parameters__
| `metaData` | _Javascript Object_ | metaData of the object (optional). |
| `callback(err, objInfo)` | _function_ | Non-null `err` indicates error, in case of Success,`objInfo` contains `etag` _string_ and `versionId` _string_ of the object. If no callback is passed, a `Promise` is returned. |
-
-__Return Value__
+**Return Value**
| Value | Type | Description |
-|---------------------|----------|-------------------------------------|
+| ------------------- | -------- | ----------------------------------- |
| `err` | _object_ | Error in case of any failures |
| `objInfo.etag` | _string_ | `etag` of an object |
| `objInfo.versionId` | _string_ | `versionId` of an object (optional) |
-
-__Example__
+**Example**
The maximum size of a single object is limited to 5TB. putObject transparently uploads objects larger than 64MiB in multiple parts. Uploaded data is carefully verified using MD5SUM signatures.
@@ -1107,68 +1132,65 @@ The maximum size of a single object is limited to 5TB. putObject transparently u
var Fs = require('fs')
var file = '/tmp/40mbfile'
var fileStream = Fs.createReadStream(file)
-var fileStat = Fs.stat(file, function(err, stats) {
+var fileStat = Fs.stat(file, function (err, stats) {
if (err) {
return console.log(err)
}
- minioClient.putObject('mybucket', '40mbfile', fileStream, stats.size, function(err, objInfo) {
- if(err) {
- return console.log(err) // err should be null
- }
- console.log("Success", objInfo)
+ minioClient.putObject('mybucket', '40mbfile', fileStream, stats.size, function (err, objInfo) {
+ if (err) {
+ return console.log(err) // err should be null
+ }
+ console.log('Success', objInfo)
})
})
```
##### From a "Buffer" or a "string"
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------------|----------------------|-------------------------------------------------------------------------------------|
+| --------------------- | -------------------- | ----------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `string or Buffer` | _Stream_ or _Buffer_ | Readable stream. |
| `metaData` | _Javascript Object_ | metaData of the object (optional). |
| `callback(err, etag)` | _function_ | Non-null `err` indicates error, `etag` _string_ is the etag of the object uploaded. |
-
-__Example__
-
+**Example**
```js
var buffer = 'Hello World'
-minioClient.putObject('mybucket', 'hello-file', buffer, function(err, etag) {
+minioClient.putObject('mybucket', 'hello-file', buffer, function (err, etag) {
return console.log(err, etag) // err should be null
})
```
+
### fPutObject(bucketName, objectName, filePath, metaData[, callback])
Uploads contents from a file to objectName.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|----------------------------------|
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `filePath` | _string_ | Path of the file to be uploaded. |
| `metaData` | _Javascript Object_ | Metadata of the object. |
| `callback(err, objInfo)` _function_: non null `err` indicates error, `objInfo` _object_ is the information about the object uploaded which contains `versionId` string and `etag` string. | | |
-__Return Value__
+**Return Value**
| Value | Type | Description |
-|---------------------|----------|-------------------------------------|
+| ------------------- | -------- | ----------------------------------- |
| `err` | _object_ | Error in case of any failures |
| `objInfo.etag` | _string_ | `etag` of an object |
| `objInfo.versionId` | _string_ | `versionId` of an object (optional) |
-__Example__
+**Example**
The maximum size of a single object is limited to 5TB. fPutObject transparently uploads objects larger than 64MiB in multiple parts. Uploaded data is carefully verified using MD5SUM signatures.
@@ -1178,78 +1200,75 @@ var metaData = {
'Content-Type': 'text/html',
'Content-Language': 123,
'X-Amz-Meta-Testing': 1234,
- 'example': 5678
+ example: 5678,
}
-minioClient.fPutObject('mybucket', '40mbfile', file, metaData, function(err, objInfo) {
- if(err) {
- return console.log(err)
- }
- console.log("Success", objInfo.etag, objInfo.versionId)
+minioClient.fPutObject('mybucket', '40mbfile', file, metaData, function (err, objInfo) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log('Success', objInfo.etag, objInfo.versionId)
})
```
+
### copyObject(bucketName, objectName, sourceObject, conditions[, callback])
Copy a source object into a new object in the specified bucket.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|---------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ------------------------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `sourceObject` | _string_ | Path of the file to be copied. |
| `conditions` | _CopyConditions_ | Conditions to be satisfied before allowing object copy. |
| `callback(err, {etag, lastModified})` | _function_ | Non-null `err` indicates error, `etag` _string_ and lastModified _Date_ are the etag and the last modified date of the object newly copied. If no callback is passed, a `Promise` is returned. |
-__Example__
+**Example**
```js
var conds = new Minio.CopyConditions()
conds.setMatchETag('bd891862ea3e22c93ed53a098218791d')
-minioClient.copyObject('mybucket', 'newobject', '/mybucket/srcobject', conds, function(e, data) {
+minioClient.copyObject('mybucket', 'newobject', '/mybucket/srcobject', conds, function (e, data) {
if (e) {
return console.log(e)
}
- console.log("Successfully copied the object:")
- console.log("etag = " + data.etag + ", lastModified = " + data.lastModified)
+ console.log('Successfully copied the object:')
+ console.log('etag = ' + data.etag + ', lastModified = ' + data.lastModified)
})
```
-
+
### statObject(bucketName, objectName, statOpts[, callback])
Gets metadata of an object.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| --------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `statOpts` | _object_ | Version of the object in the form `{versionId:"my-versionId"}`. Default is `{}`. (optional) |
| `callback(err, stat)` | _function_ | `err` is not `null` in case of error, `stat` contains the object information listed below. If no callback is passed, a `Promise` is returned. |
-__Return Value__
+**Return Value**
| Param | Type | Description |
-|---------------------|---------------------|---------------------------|
+| ------------------- | ------------------- | ------------------------- |
| `stat.size` | _number_ | size of the object. |
| `stat.etag` | _string_ | etag of the object. |
| `stat.versionId` | _string_ | version of the object. |
| `stat.metaData` | _Javascript Object_ | metadata of the object. |
| `stat.lastModified` | _Date_ | Last Modified time stamp. |
-
-__Example__
-
+**Example**
```js
-minioClient.statObject('mybucket', 'photo.jpg', function(err, stat) {
+minioClient.statObject('mybucket', 'photo.jpg', function (err, stat) {
if (err) {
return console.log(err)
}
@@ -1257,11 +1276,10 @@ minioClient.statObject('mybucket', 'photo.jpg', function(err, stat) {
})
```
-__Example stat on a version of an object__
-
+**Example stat on a version of an object**
```js
-minioClient.statObject('mybucket', 'photo.jpg', { versionId : "my-versionId" }, function(err, stat) {
+minioClient.statObject('mybucket', 'photo.jpg', { versionId: 'my-versionId' }, function (err, stat) {
if (err) {
return console.log(err)
}
@@ -1270,148 +1288,138 @@ minioClient.statObject('mybucket', 'photo.jpg', { versionId : "my-versionId" },
```
+
### removeObject(bucketName, objectName [, removeOpts] [, callback])
Removes an object.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|-------------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `removeOpts` | _object_ | Version of the object in the form `{versionId:"my-versionId", governanceBypass: true or false }`. Default is `{}`. (Optional) |
| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
-__Example 1__
+**Example 1**
```js
-(async function () {
- await minioClient.removeObject("mybucket", "photo.jpg");
- console.log("Removed the object");
-})();
+;(async function () {
+ await minioClient.removeObject('mybucket', 'photo.jpg')
+ console.log('Removed the object')
+})()
```
-__Example 2__
+**Example 2**
Delete a specific version of an object
```js
-(async function () {
+;(async function () {
try {
- await minioClient.removeObject('mybucket', 'photo.jpg', { versionId : "my-versionId" })
+ await minioClient.removeObject('mybucket', 'photo.jpg', { versionId: 'my-versionId' })
console.log('Removed the object')
} catch (err) {
console.log('Unable to remove object', err)
}
-})();
+})()
```
-__Example 3__
+**Example 3**
Remove an object version locked with retention mode `GOVERNANCE` using the `governanceBypass` remove option
```js
-(async function () {
- await s3Client.removeObject('my-bucketname', 'my-objectname', {versionId:"my-versionId", governanceBypass:true})
- console.log("Success")
-})();
+;(async function () {
+ await s3Client.removeObject('my-bucketname', 'my-objectname', { versionId: 'my-versionId', governanceBypass: true })
+ console.log('Success')
+})()
```
+
### removeObjects(bucketName, objectsList[, callback])
Remove all objects in the objectsList.
-__Parameters__
-
-
-| Param | Type | Description |
-|-----------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `bucketName` | _string_ | Name of the bucket. |
-| `objectsList` | _object_ | list of objects in the bucket to be removed. any one of the formats: 1. List of Object names as array of strings which are object keys: `['objectname1','objectname2']` 2. List of Object name and VersionId as an object: [{name:"my-obj-name",versionId:"my-versionId"}] |
-| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. |
-
+**Parameters**
-__Example__
+| Param | Type | Description |
+| --------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bucketName` | _string_ | Name of the bucket. |
+| `objectsList` | _object_ | list of objects in the bucket to be removed. any one of the formats: 1. List of Object names as array of strings which are object keys: `['objectname1','objectname2']` 2. List of Object name and VersionId as an object: [{name:"my-obj-name",versionId:"my-versionId"}] |
+| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. |
+**Example**
```js
-
var objectsList = []
// List all object paths in bucket my-bucketname.
var objectsStream = s3Client.listObjects('my-bucketname', 'my-prefixname', true)
-objectsStream.on('data', function(obj) {
- objectsList.push(obj.name);
+objectsStream.on('data', function (obj) {
+ objectsList.push(obj.name)
})
-objectsStream.on('error', function(e) {
- console.log(e);
+objectsStream.on('error', function (e) {
+ console.log(e)
})
-objectsStream.on('end', function() {
-
- s3Client.removeObjects('my-bucketname',objectsList, function(e) {
+objectsStream.on('end', function () {
+ s3Client.removeObjects('my-bucketname', objectsList, function (e) {
if (e) {
- return console.log('Unable to remove Objects ',e)
+ return console.log('Unable to remove Objects ', e)
}
console.log('Removed the objects successfully')
})
-
})
-
-
```
-__Example1__
+**Example1**
-With versioning Support
+With versioning Support
```js
-var objectsList=[]
-var bucket ="my-bucket"
-var prefix="my-prefix"
-var recursive=false
+var objectsList = []
+var bucket = 'my-bucket'
+var prefix = 'my-prefix'
+var recursive = false
-var objectsStream = s3Client.listObjects(bucket, prefix, recursive, {IncludeVersion: true})
- objectsStream.on('data', function (obj) {
- objectsList.push(obj)
- })
- objectsStream.on('error', function (e) {
- return console.log(e)
- })
- objectsStream.on('end', function () {
- s3Client.removeObjects(bucket, objectsList, function (e) {
- if (e) {
- return console.log(e)
- }
- console.log("Success")
- })
+var objectsStream = s3Client.listObjects(bucket, prefix, recursive, { IncludeVersion: true })
+objectsStream.on('data', function (obj) {
+ objectsList.push(obj)
+})
+objectsStream.on('error', function (e) {
+ return console.log(e)
+})
+objectsStream.on('end', function () {
+ s3Client.removeObjects(bucket, objectsList, function (e) {
+ if (e) {
+ return console.log(e)
+ }
+ console.log('Success')
})
-
+})
```
+
### removeIncompleteUpload(bucketName, objectName[, callback])
Removes a partially uploaded object.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
-
-__Example__
-
+**Example**
```js
-minioClient.removeIncompleteUpload('mybucket', 'photo.jpg', function(err) {
+minioClient.removeIncompleteUpload('mybucket', 'photo.jpg', function (err) {
if (err) {
return console.log('Unable to remove incomplete object', err)
}
@@ -1419,64 +1427,65 @@ minioClient.removeIncompleteUpload('mybucket', 'photo.jpg', function(err) {
})
```
-
+
### putObjectRetention(bucketName, objectName [, retentionOpts] [, callback])
Apply retention on an object.
-__Parameters__
-
-| Param | Type | Description |
-|-----------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `bucketName` | _string_ | Name of the bucket. |
-| `objectName` | _string_ | Name of the object. |
-| `retentionOpts` | _object_ | Options for retention like : `{ governanceBypass:true/false ,mode:COMPLIANCE/GOVERNANCE, retainUntilDate: _date_ , versionId:"my-versionId" }` Default is `{}` (Optional) |
-| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
+**Parameters**
+| Param | Type | Description |
+| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bucketName` | _string_ | Name of the bucket. |
+| `objectName` | _string_ | Name of the object. |
+| `retentionOpts` | _object_ | Options for retention like : `{ governanceBypass:true/false ,mode:COMPLIANCE/GOVERNANCE, retainUntilDate: _date_ , versionId:"my-versionId" }` Default is `{}` (Optional) |
+| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
-__Example__
+**Example**
Apply object retention on an object
```js
const bucketName = 'my-bucket'
-const objectName ="my-object"
+const objectName = 'my-object'
const expirationDate = new Date()
expirationDate.setDate(expirationDate.getDate() + 1)
-expirationDate.setUTCHours(0,0,0,0)//Should be start of the day.(midnight)
-const versionId ="e67b4b08-144d-4fc4-ba15-43c3f7f9ba74"
+expirationDate.setUTCHours(0, 0, 0, 0) //Should be start of the day.(midnight)
+const versionId = 'e67b4b08-144d-4fc4-ba15-43c3f7f9ba74'
const objRetPromise = minioClient.putObjectRetention(
- bucketName,
- objectName,
- { Mode:"GOVERNANCE", retainUntilDate:retainUntilDate.toISOString(), versionId:versionId },
- function (err){
+ bucketName,
+ objectName,
+ { Mode: 'GOVERNANCE', retainUntilDate: retainUntilDate.toISOString(), versionId: versionId },
+ function (err) {
if (err) {
- return console.log(err)
+ return console.log(err)
}
- console.log("Success")
-})
+ console.log('Success')
+ },
+)
```
+
### getObjectRetention(bucketName, objectName [, getOpts] [, callback])
Get retention config of an object
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|----------------------|------------|----------------------------------------------------------------------------------------------------------------------------------|
+| -------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
-| `getOpts` | _object_ | Options for retention like : `{ versionId:"my-versionId" }` Default is `{}` (Optional) |
+| `getOpts` | _object_ | Options for retention like : `{ versionId:"my-versionId" }` Default is `{}` (Optional) |
| `callback(err, res)` | _function_ | Callback is called with `err` in case of error. `res` is the response object. If no callback is passed, a `Promise` is returned. |
-__Example__
+**Example**
```js
-minioClient.getObjectRetention('bucketname', 'bucketname', { versionId: "my-versionId" }, function (err, res){
+minioClient.getObjectRetention('bucketname', 'bucketname', { versionId: 'my-versionId' }, function (err, res) {
if (err) {
return console.log(err)
}
@@ -1485,138 +1494,146 @@ minioClient.getObjectRetention('bucketname', 'bucketname', { versionId: "my-vers
```
+
### setObjectTagging(bucketName, objectName, tags[, putOpts, callback])
Put Tags on an Object
-__Parameters__
+**Parameters**
-| Param | Type | Description |
-|-----------------|------------|---------------------------------------------------------------|
-| `bucketName` | _string_ | Name of the bucket. |
-| `objectName` | _string_ | Name of the object. |
-| `tags` | _object_ | Tags map Configuration e.g: `{:}` |
-| `putOpts` | _object_ | Default is {}. e.g `{versionId:"my-version-id"}`. (Optional) |
-| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
+| Param | Type | Description |
+| --------------- | ---------- | ------------------------------------------------------------ |
+| `bucketName` | _string_ | Name of the bucket. |
+| `objectName` | _string_ | Name of the object. |
+| `tags` | _object_ | Tags map Configuration e.g: `{:}` |
+| `putOpts` | _object_ | Default is {}. e.g `{versionId:"my-version-id"}`. (Optional) |
+| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
+
+**Example**
-__Example__
```js
-minioClient.setObjectTagging('bucketname','object-name', tags, function (err){
+minioClient.setObjectTagging('bucketname', 'object-name', tags, function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
-__Example 1__
+**Example 1**
Put tags on a version of an object.
```js
-minioClient.setObjectTagging('bucketname','object-name', tags, { versionId: "my-version-id" }, function (err){
+minioClient.setObjectTagging('bucketname', 'object-name', tags, { versionId: 'my-version-id' }, function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
+
### removeObjectTagging(bucketName, objectName[, removeOpts, callback])
Remove Tags on an Object
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|---------------------------------------------------------------|
+| --------------- | ---------- | ------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `removeOpts` | _object_ | Defaults to {}. e.g `{versionId:"my-version-id"}`. (Optional) |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-minioClient.removeObjectTagging('bucketname','object-name', function (err){
+minioClient.removeObjectTagging('bucketname', 'object-name', function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
-
-__Example1__
+**Example1**
Remove tags on a version of an object.
```js
-minioClient.removeObjectTagging('bucketname', 'object-name', {versionId:"my-object-version-id"}, function (err){
+minioClient.removeObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' }, function (err) {
if (err) {
return console.log(err)
}
- console.log("Success")
+ console.log('Success')
})
```
+
### getObjectTagging(bucketName, objectName[, getOpts, callback])
Get Tags of an Object
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|---------------------------------------------------------------|
+| --------------- | ---------- | ------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `getOpts` | _object_ | Defaults to {}. e.g `{versionId:"my-version-id"}`. (Optional) |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
-__Example__
+**Example**
+
```js
-minioClient.getObjectTagging('bucketname', 'object-name', function (err, tagsList){
+minioClient.getObjectTagging('bucketname', 'object-name', function (err, tagsList) {
if (err) {
return console.log(err)
}
- console.log("Success", tagsList)
+ console.log('Success', tagsList)
})
```
-
-__Example1__
+**Example1**
Get tags on a version of an object.
```js
-minioClient.getObjectTagging('bucketname', 'object-name', {versionId:"my-object-version-id"}, function (err, tagsList){
- if (err) {
- return console.log(err)
- }
- console.log("Success", tagsList)
-})
+minioClient.getObjectTagging(
+ 'bucketname',
+ 'object-name',
+ { versionId: 'my-object-version-id' },
+ function (err, tagsList) {
+ if (err) {
+ return console.log(err)
+ }
+ console.log('Success', tagsList)
+ },
+)
```
+
### getObjectLegalHold(bucketName, objectName, getOpts [, callback])
Get legal hold on an object.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `getOpts` | _object_ | Legal hold configuration options. e.g `{versionId:'my-version-uuid'}` defaults to `{}` . |
| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
-
-__Example 1__
+**Example 1**
Get Legal hold of an object.
```js
-minioClient.getObjectLegalHold('bucketName', 'objectName', {}, function(err, res) {
+minioClient.getObjectLegalHold('bucketName', 'objectName', {}, function (err, res) {
if (err) {
return console.log('Unable to get legal hold config for the object', err.message)
}
@@ -1624,12 +1641,12 @@ minioClient.getObjectLegalHold('bucketName', 'objectName', {}, function(err, res
})
```
-__Example 2__
+**Example 2**
Get Legal hold of an object with versionId.
```js
-minioClient.getObjectLegalHold('bucketName', 'objectName', { versionId:'my-obj-version-uuid' }, function(err, res) {
+minioClient.getObjectLegalHold('bucketName', 'objectName', { versionId: 'my-obj-version-uuid' }, function (err, res) {
if (err) {
return console.log('Unable to get legal hold config for the object', err.message)
}
@@ -1637,27 +1654,27 @@ minioClient.getObjectLegalHold('bucketName', 'objectName', { versionId:'my-obj-v
})
```
-
+
### setObjectLegalHold(bucketName, objectName, [,setOpts, callback])
Set legal hold on an object.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `setOpts` | _object_ | Legal hold configuration options to set. e.g `{versionId:'my-version-uuid', status:'ON or OFF'}` defaults to `{status:'ON'}` if not passed. |
| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
-__Example 1__
+**Example 1**
Set Legal hold of an object.
+
```js
-minioClient.setObjectLegalHold('bucketName', 'objectName', {Status:"ON"}, function(err, res) {
+minioClient.setObjectLegalHold('bucketName', 'objectName', { Status: 'ON' }, function (err, res) {
if (err) {
return console.log('Unable to set legal hold config for the object', err.message)
}
@@ -1665,101 +1682,109 @@ minioClient.setObjectLegalHold('bucketName', 'objectName', {Status:"ON"}, functi
})
```
-__Example 2__
+**Example 2**
Set Legal hold of an object with versionId.
+
```js
-minioClient.setObjectLegalHold('bucketName', 'objectName', { Status:"ON", versionId:'my-obj-version-uuid' }, function(err, res) {
- if (err) {
- return console.log('Unable to set legal hold config for the object version', err.message)
- }
- console.log('Success')
-})
+minioClient.setObjectLegalHold(
+ 'bucketName',
+ 'objectName',
+ { Status: 'ON', versionId: 'my-obj-version-uuid' },
+ function (err, res) {
+ if (err) {
+ return console.log('Unable to set legal hold config for the object version', err.message)
+ }
+ console.log('Success')
+ },
+)
```
-
+
### composeObject(destObjConfig, sourceObjectList [, callback])
Compose an object from parts
-__Parameters__
-
-
-| Param | Type | Description |
-|--------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `destObjConfig` | _object_ | Destination Object configuration of the type [CopyDestinationOptions](https://github.com/minio/minio-js/blob/master/src/helpers.js) |
-| `sourceObjectList` | _object[]_ | Array of object(parts) source to compose into an object. Each part configuration should be of type [CopySourceOptions](https://github.com/minio/minio-js/blob/master/src/helpers.js) |
-| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
+**Parameters**
+| Param | Type | Description |
+| ------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `destObjConfig` | _object_ | Destination Object configuration of the type [CopyDestinationOptions](https://github.com/minio/minio-js/blob/master/src/helpers.js) |
+| `sourceObjectList` | _object[]_ | Array of object(parts) source to compose into an object. Each part configuration should be of type [CopySourceOptions](https://github.com/minio/minio-js/blob/master/src/helpers.js) |
+| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned. |
-__Example 1__
+**Example 1**
Compose an Object from its parts .
```js
-const sourceList = [new Helpers.CopySourceOptions( {
- Bucket: "source-bucket",
- Object: "parta",
-}),new Helpers.CopySourceOptions({
- Bucket: "source-bucket",
- Object: "partb",
-}),new Helpers.CopySourceOptions({
- Bucket: "source-bucket",
- Object: "partc",
-
-}),new Helpers.CopySourceOptions({
- Bucket: "source-bucket",
- Object: "partd",
-})]
+const sourceList = [
+ new Helpers.CopySourceOptions({
+ Bucket: 'source-bucket',
+ Object: 'parta',
+ }),
+ new Helpers.CopySourceOptions({
+ Bucket: 'source-bucket',
+ Object: 'partb',
+ }),
+ new Helpers.CopySourceOptions({
+ Bucket: 'source-bucket',
+ Object: 'partc',
+ }),
+ new Helpers.CopySourceOptions({
+ Bucket: 'source-bucket',
+ Object: 'partd',
+ }),
+]
const destOption = new Helpers.CopyDestinationOptions({
- Bucket: "dest-bucket",
- Object: "100MB.zip"
+ Bucket: 'dest-bucket',
+ Object: '100MB.zip',
})
//using Promise style.
-const composePromise = minioClient.composeObject(destOption,sourceList)
- composePromise.then((result) => {
- console.log("Success...")
- })
- .catch((e)=>{
- console.log("error",e)
- })
-
+const composePromise = minioClient.composeObject(destOption, sourceList)
+composePromise
+ .then((result) => {
+ console.log('Success...')
+ })
+ .catch((e) => {
+ console.log('error', e)
+ })
```
+
### selectObjectContent(bucketName, objectName, selectOpts[, callback])
Select contents of an object (S3 Select).
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `selectOpts` | _object_ | |
| `callback(err)` | _function_ | Callback function is called with non `null` value in case of error. If no callback is passed, a `Promise` is returned, with the `SelectResults` type |
-__Example 1__
+**Example 1**
Select all values
+
```js
const selectOpts = {
- expression:"SELECT * FROM s3object s where s.\"Name\" = 'Jane'",
- expressionType:"SQL",
- inputSerialization : {'CSV': {"FileHeaderInfo": "Use",
- RecordDelimiter: "\n",
- FieldDelimiter: ",",
- },
- 'CompressionType': 'NONE'},
- outputSerialization : {'CSV': {RecordDelimiter: "\n",
- FieldDelimiter: ",",}},
- requestProgress:{Enabled:true},
+ expression: 'SELECT * FROM s3object s where s."Name" = \'Jane\'',
+ expressionType: 'SQL',
+ inputSerialization: {
+ CSV: { FileHeaderInfo: 'Use', RecordDelimiter: '\n', FieldDelimiter: ',' },
+ CompressionType: 'NONE',
+ },
+ outputSerialization: { CSV: { RecordDelimiter: '\n', FieldDelimiter: ',' } },
+ requestProgress: { Enabled: true },
}
-minioClient.selectObjectContent('bucketName', 'objectName', selectOpts, function(err, res) {
+minioClient.selectObjectContent('bucketName', 'objectName', selectOpts, function (err, res) {
if (err) {
return console.log('Unable to process select object content.', err.message)
}
@@ -1767,23 +1792,20 @@ minioClient.selectObjectContent('bucketName', 'objectName', selectOpts, function
})
```
-
## 4. Presigned operations
Presigned URLs are generated for temporary download/upload access to private objects.
+
### presignedUrl(httpMethod, bucketName, objectName[, expiry, reqParams, requestDate, cb])
Generates a presigned URL for the provided HTTP method, 'httpMethod'. Browsers/Mobile clients may point to this URL to directly download objects even if the bucket is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.
-
-__Parameters__
-
-
+**Parameters**
| Param | Type | Description |
-|-------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `expiry` | _number_ | Expiry time in seconds. Default value is 7 days. (optional) |
@@ -1791,56 +1813,63 @@ __Parameters__
| `requestDate` | _Date_ | A date object, the url will be issued at. Default value is now. (optional) |
| `callback(err, presignedUrl)` | _function_ | Callback function is called with non `null` err value in case of error. `presignedUrl` will be the URL using which the object can be downloaded using GET request. If no callback is passed, a `Promise` is returned. |
-
-__Example1__
-
+**Example1**
```js
// presigned url for 'getObject' method.
// expires in a day.
-minioClient.presignedUrl('GET', 'mybucket', 'hello.txt', 24*60*60, function(err, presignedUrl) {
+minioClient.presignedUrl('GET', 'mybucket', 'hello.txt', 24 * 60 * 60, function (err, presignedUrl) {
if (err) return console.log(err)
console.log(presignedUrl)
})
```
-
-__Example2__
-
+**Example2**
```js
// presigned url for 'listObject' method.
// Lists objects in 'myBucket' with prefix 'data'.
// Lists max 1000 of them.
-minioClient.presignedUrl('GET', 'mybucket', '', 1000, {'prefix': 'data', 'max-keys': 1000}, function(err, presignedUrl) {
- if (err) return console.log(err)
- console.log(presignedUrl)
-})
+minioClient.presignedUrl(
+ 'GET',
+ 'mybucket',
+ '',
+ 1000,
+ { prefix: 'data', 'max-keys': 1000 },
+ function (err, presignedUrl) {
+ if (err) return console.log(err)
+ console.log(presignedUrl)
+ },
+)
```
-__Example 3__
-
+**Example 3**
```js
// Get Object with versionid
-minioClient.presignedUrl('GET', 'mybucket', '', 1000, {versionId: "10fa9946-3f64-4137-a58f-888065c0732e"}, function(err, presignedUrl) {
- if (err) return console.log(err)
- console.log(presignedUrl)
-})
+minioClient.presignedUrl(
+ 'GET',
+ 'mybucket',
+ '',
+ 1000,
+ { versionId: '10fa9946-3f64-4137-a58f-888065c0732e' },
+ function (err, presignedUrl) {
+ if (err) return console.log(err)
+ console.log(presignedUrl)
+ },
+)
```
+
### presignedGetObject(bucketName, objectName[, expiry, respHeaders, requestDate, cb])
Generates a presigned URL for HTTP GET operations. Browsers/Mobile clients may point to this URL to directly download objects even if the bucket is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.
-
-__Parameters__
-
-
+**Parameters**
| Param | Type | Description |
-|-------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `expiry` | _number_ | Expiry time in seconds. Default value is 7 days. (optional) |
@@ -1848,63 +1877,56 @@ __Parameters__
| `requestDate` | _Date_ | A date object, the url will be issued at. Default value is now. (optional) |
| `callback(err, presignedUrl)` | _function_ | Callback function is called with non `null` err value in case of error. `presignedUrl` will be the URL using which the object can be downloaded using GET request. If no callback is passed, a `Promise` is returned. |
-
-__Example__
-
+**Example**
```js
// expires in a day.
-minioClient.presignedGetObject('mybucket', 'hello.txt', 24*60*60, function(err, presignedUrl) {
+minioClient.presignedGetObject('mybucket', 'hello.txt', 24 * 60 * 60, function (err, presignedUrl) {
if (err) return console.log(err)
console.log(presignedUrl)
})
```
-### presignedPutObject(bucketName, objectName, expiry[, callback])
-
-Generates a presigned URL for HTTP PUT operations. Browsers/Mobile clients may point to this URL to upload objects directly to a bucket even if it is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.
+### presignedPutObject(bucketName, objectName, expiry[, callback])
-__Parameters__
+Generates a presigned URL for HTTP PUT operations. Browsers/Mobile clients may point to this URL to upload objects directly to a bucket even if it is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.
+**Parameters**
| Param | Type | Description |
-|-------------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `expiry` | _number_ | Expiry time in seconds. Default value is 7 days. |
| `callback(err, presignedUrl)` | _function_ | Callback function is called with non `null` err value in case of error. `presignedUrl` will be the URL using which the object can be uploaded using PUT request. If no callback is passed, a `Promise` is returned. |
-
-__Example__
-
+**Example**
```js
// expires in a day.
-minioClient.presignedPutObject('mybucket', 'hello.txt', 24*60*60, function(err, presignedUrl) {
+minioClient.presignedPutObject('mybucket', 'hello.txt', 24 * 60 * 60, function (err, presignedUrl) {
if (err) return console.log(err)
console.log(presignedUrl)
})
```
+
### presignedPostPolicy(policy[, callback])
Allows setting policy conditions to a presigned URL for POST operations. Policies such as bucket name to receive object uploads, key name prefixes, expiry policy may be set.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|--------------------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ------------------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `policy` | _object_ | Policy object created by minioClient.newPostPolicy() |
| `callback(err, {postURL, formData})` | _function_ | Callback function is called with non `null` err value in case of error. `postURL` will be the URL using which the object can be uploaded using POST request. `formData` is the object having key/value pairs for the Form data of POST body. If no callback is passed, a `Promise` is returned. |
-
Create policy:
-
```js
var policy = minioClient.newPostPolicy()
```
@@ -1918,13 +1940,14 @@ policy.setBucket('mybucket')
// Policy restricted only for hello.txt object.
policy.setKey('hello.txt')
```
+
or
```js
// Policy restricted for incoming objects with keyPrefix.
policy.setKeyStartsWith('keyPrefix')
-var expires = new Date
+var expires = new Date()
expires.setSeconds(24 * 60 * 60 * 10)
// Policy expires in 10 days.
policy.setExpires(expires)
@@ -1936,30 +1959,29 @@ policy.setContentType('text/plain')
policy.setContentDisposition('attachment; filename=text.txt')
// Only allow content size in range 1KB to 1MB.
-policy.setContentLengthRange(1024, 1024*1024)
+policy.setContentLengthRange(1024, 1024 * 1024)
// Set key-value user defined metadata
policy.setUserMetaData({
- key: 'value'
+ key: 'value',
})
```
POST your content from the browser using `superagent`:
-
```js
-minioClient.presignedPostPolicy(policy, function(err, data) {
+minioClient.presignedPostPolicy(policy, function (err, data) {
if (err) return console.log(err)
var req = superagent.post(data.postURL)
- _.each(data.formData, function(value, key) {
+ _.each(data.formData, function (value, key) {
req.field(key, value)
})
// file contents.
req.attach('file', '/path/to/hello.txt', 'hello.txt')
- req.end(function(err, res) {
+ req.end(function (err, res) {
if (err) {
return console.log(err.toString())
}
@@ -1973,51 +1995,46 @@ minioClient.presignedPostPolicy(policy, function(err, data) {
Buckets are configured to trigger notifications on specified types of events and paths filters.
+
### getBucketNotification(bucketName[, cb])
Fetch the notification configuration stored in the S3 provider and that belongs to the specified bucket name.
-__Parameters__
-
-
+**Parameters**
| Param | Type | Description |
-|-------------------------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, bucketNotificationConfig)` | _function_ | Callback function is called with non `null` err value in case of error. `bucketNotificationConfig` will be the object that carries all notification configurations associated to bucketName. If no callback is passed, a `Promise` is returned. |
-
-__Example__
-
+**Example**
```js
-minioClient.getBucketNotification('mybucket', function(err, bucketNotificationConfig) {
+minioClient.getBucketNotification('mybucket', function (err, bucketNotificationConfig) {
if (err) return console.log(err)
console.log(bucketNotificationConfig)
})
```
+
### setBucketNotification(bucketName, bucketNotificationConfig[, callback])
Upload a user-created notification configuration and associate it to the specified bucket name.
-
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|----------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------|
+| -------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `bucketNotificationConfig` | _BucketNotification_ | Javascript object that carries the notification configuration. |
| `callback(err)` | _function_ | Callback function is called with non `null` err value in case of error. If no callback is passed, a `Promise` is returned. |
-
-__Example__
+**Example**
```js
// Create a new notification object
-var bucketNotification = new Minio.NotificationConfig();
+var bucketNotification = new Minio.NotificationConfig()
// Setup a new Queue configuration
var arn = Minio.buildARN('aws', 'sqs', 'us-west-2', '1', 'webhook')
@@ -2030,36 +2047,36 @@ queue.addEvent(Minio.ObjectCreatedAll)
// Add the queue to the overall notification object
bucketNotification.add(queue)
-minioClient.setBucketNotification('mybucket', bucketNotification, function(err) {
+minioClient.setBucketNotification('mybucket', bucketNotification, function (err) {
if (err) return console.log(err)
console.log('Success')
})
```
+
### removeAllBucketNotification(bucketName[, callback])
Remove the bucket notification configuration associated to the specified bucket.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|----------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket |
| `callback(err)` | _function_ | Callback function is called with non `null` err value in case of error. If no callback is passed, a `Promise` is returned. |
-
```js
-minioClient.removeAllBucketNotification('my-bucketname', function(e) {
+minioClient.removeAllBucketNotification('my-bucketname', function (e) {
if (e) {
return console.log(e)
}
- console.log("True")
+ console.log('True')
})
```
+
### listenBucketNotification(bucketName, prefix, suffix, events)
Listen for notifications on a bucket. Additionally one can provider
@@ -2071,10 +2088,10 @@ Returns an `EventEmitter`, which will emit a `notification` event carrying the r
To stop listening, call `.stop()` on the returned `EventEmitter`.
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|--------------|----------|-------------------------------------------------|
+| ------------ | -------- | ----------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket |
| `prefix` | _string_ | Object key prefix to filter notifications for. |
| `suffix` | _string_ | Object key suffix to filter notifications for. |
@@ -2084,7 +2101,7 @@ See [here](https://github.com/minio/minio-js/blob/master/examples/minio/listen-b
```js
var listener = minioClient.listenBucketNotification('my-bucketname', 'photos/', '.jpg', ['s3:ObjectCreated:*'])
-listener.on('notification', function(record) {
+listener.on('notification', function (record) {
// For example: 's3:ObjectCreated:Put event occurred (2016-08-23T18:26:07.214Z)'
console.log('%s event occurred (%s)', record.eventName, record.eventTime)
listener.stop()
@@ -2092,24 +2109,23 @@ listener.on('notification', function(record) {
```
+
### getBucketPolicy(bucketName [, callback])
Get the bucket policy associated with the specified bucket. If `objectPrefix`
is not empty, the bucket policy will be filtered based on object permissions
as well.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ----------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket |
| `callback(err, policy)` | _function_ | Callback function is called with non `null` err value in case of error. `policy` is [bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html). If no callback is passed, a `Promise` is returned. |
-
```js
// Retrieve bucket policy of 'my-bucketname'
-minioClient.getBucketPolicy('my-bucketname', function(err, policy) {
+minioClient.getBucketPolicy('my-bucketname', function (err, policy) {
if (err) throw err
console.log(`Bucket policy file: ${policy}`)
@@ -2117,53 +2133,54 @@ minioClient.getBucketPolicy('my-bucketname', function(err, policy) {
```
+
### setBucketPolicy(bucketName, bucketPolicy[, callback])
Set the bucket policy on the specified bucket. [bucketPolicy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html) is detailed here.
-__Parameters__
-
+**Parameters**
| Param | Type | Description |
-|-----------------|------------|----------------------------------------------------------------------------------------------------------------------------|
+| --------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------- |
| `bucketName` | _string_ | Name of the bucket. |
| `bucketPolicy` | _string_ | bucket policy. |
| `callback(err)` | _function_ | Callback function is called with non `null` err value in case of error. If no callback is passed, a `Promise` is returned. |
-
```js
// Set the bucket policy of `my-bucketname`
-minioClient.setBucketPolicy('my-bucketname', JSON.stringify(policy), function(err) {
+minioClient.setBucketPolicy('my-bucketname', JSON.stringify(policy), function (err) {
if (err) throw err
console.log('Bucket policy set')
})
```
+
## 6. Custom Settings
+
### setS3TransferAccelerate(endpoint)
+
Set AWS S3 transfer acceleration endpoint for all API requests hereafter.
NOTE: This API applies only to AWS S3 and is a no operation for S3 compatible object storage services.
-__Parameters__
+**Parameters**
| Param | Type | Description |
-|------------|----------|-----------------------------------------------|
+| ---------- | -------- | --------------------------------------------- |
| `endpoint` | _string_ | Set to new S3 transfer acceleration endpoint. |
-
## 7. HTTP request options
+
### setRequestOptions(options)
Set the HTTP/HTTPS request options. Supported options are `agent` ([http.Agent()](https://nodejs.org/api/http.html#http_class_http_agent)), `family` ([IP address family to use while resolving `host` or `hostname`](https://nodejs.org/api/http.html#http_http_request_url_options_callback)), and tls related options ('agent', 'ca', 'cert', 'ciphers', 'clientCertEngine', 'crl', 'dhparam', 'ecdhCurve', 'honorCipherOrder', 'key', 'passphrase', 'pfx', 'rejectUnauthorized', 'secureOptions', 'secureProtocol', 'servername', 'sessionIdContext') documented [here](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options)
```js
// Do not reject self signed certificates.
-minioClient.setRequestOptions({rejectUnauthorized: false})
+minioClient.setRequestOptions({ rejectUnauthorized: false })
```
-
## 7. Explore Further
- [Build your own Shopping App Example](https://github.com/minio/minio-js-store-app)