buckets

Methods

(static) createBucket(bucketName) → {Object}

Description:

• Create a new bucket
  see: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/createbucketcommand.html

Source:

• Bucket.js, line 80

Example

Usage

await Qarnot.buckets.createBucket('my-bucket');

Parameters:

Returns:

Type

Object

(static) deleteBucket(bucketName) → {Promise}

Description:

• Delete a bucket
  see: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/deletebucketcommand.html

Source:

• Bucket.js, line 100

Example

Usage

await Qarnot.buckets.deleteBucket('my-bucket-to-delete');

Parameters:

Returns:

Type

Promise

(static) deleteFile() → {Promise}

Description:

• Delete a file in a bucket see: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/deleteobjectcommand.html

Source:

• Bucket.js, line 221

Example

await Qarnot.buckets.deleteFile('my-bucket', 'file.txt');

Returns:

Type

Promise

(static) download(bucketName, fileName) → {Promise.<Buffer>}

Description:

• Download content of a file in a bucket
  see: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/getobjectcommand.html

Source:

• Bucket.js, line 150

Examples

Usage

const data = await Qarnot.buckets.download('my-bucket', 'file.txt', params);
console.log(data)
console.log(data.Body.toString())

Output

{
   AcceptRanges: 'bytes',
   LastModified: 2019-06-11T20:13:17.000Z,
   ContentLength: 11,
   ETag: '"5eb63bbbe01eeed093cb22bb8f5acdc3"',
   ContentType: 'application/octet-stream',
   Metadata: {},
   Body: <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>
}
hello world

Parameters:

Returns:

Type

Promise.<Buffer>

(static) listBuckets() → {Object}

Description:

• List all buckets
  see: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/listbucketscommand.html

Source:

• Bucket.js, line 57

Examples

Usage

const buckets = await Qarnot.buckets.listBuckets();
console.log(buckets);

Output

{
   Buckets: [
     { Name: 'my-bucket', CreationDate: 2019-06-11T12:59:43.743Z }
   ],
   Owner: { DisplayName: 'john.doe', ID: 'xx$xx' }
}

Returns:

Type

Object

(static) listFiles(bucketName, paramsopt) → {Promise.<Object>}

Description:

• List all files in a bucket
  see: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/classes/listobjectsv2command.html

Source:

• Bucket.js, line 185

Examples

Usage

const files = await Qarnot.buckets.listFiles('my-bucket');
console.log(files);

Output

{
  Contents: [
    {
      Key: 'test.txt',
      LastModified: 2023-05-30T09:30:53.873Z,
      ETag: '"f7482490035aa20e0bed1375d44e97bf"',
      Size: 17,
      StorageClass: 'STANDARD'
    }
  ],
  IsTruncated: false,
  KeyCount: 1,
  MaxKeys: 1000,
  Name: 'test-suite-nodejs',
  Prefix: ''
}

Parameters:

Returns:

Type

Promise.<Object>

(static) upload(bucketName, fileName, data) → {Promise.<Object>}

Description:

• Upload data in a bucket
  see: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_storage.html

Source:

• Bucket.js, line 117

Examples

Usage

const file = await Qarnot.buckets.upload('my-bucket', 'file.txt', data, mimetype);
console.log(file);

Output

 {
  ETag: '"f7482490035aa20e0bed1375d44e97bf"',
  Bucket: 'test-suite-nodejs',
  Key: 'test.txt',
  Location: 'https://test-suite-nodejs.storage.qarnot.com/test.txt'
}

Parameters:

Returns:

Type

Promise.<Object>