Skip to content

Latest commit

 

History

History

s3

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
cmd
cmd
 
 
lib
lib
 
 
test
test
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
index.js
index.js
 
 
manifest.ttl
manifest.ttl
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

barnard59-s3

Add support for S3 to barnard59.

Working with files

getObject

Get an object from a S3 bucket into the file system.

Option Type Required Description
bucket string true The name of the S3 bucket
key string true The key of the object
destinationPath string true The path where the object should be downloaded. If the directory that contains the path do not exist, it will be created.
accessKeyId string false S3 Access Key ID
secretAccessKey string false S3 Secret Access Key

And all options from S3ClientConfigType of the AWS SDK, which includes those fields for example:

  • endpoint (type: string ; configure a custom endpoint)
  • region (type: string ; defaults to us-east-1 if not specified)
  • forcePathStyle (type: boolean; set to true if you want to use a custom endpoint)

putObject

Put an object from the file system into a S3 bucket.

Option Type Required Description
bucket string true The name of the S3 bucket
key string true The key of the object
sourcePath string true The path of the file on the local file system
accessKeyId string false S3 Access Key ID
secretAccessKey string false S3 Secret Access Key

And all options from S3ClientConfigType of the AWS SDK, which includes those fields for example:

  • endpoint (type: string ; configure a custom endpoint)
  • region (type: string ; defaults to us-east-1 if not specified)
  • forcePathStyle (type: boolean; set to true if you want to use a custom endpoint)

Working with streams

getObjectStream (getObject/stream operation)

Get an object from a S3 bucket as a Readable stream.

Option Type Required Description
bucket string true The name of the S3 bucket
key string true The key of the object
accessKeyId string false S3 Access Key ID
secretAccessKey string false S3 Secret Access Key

And all options from S3ClientConfigType of the AWS SDK, which includes those fields for example:

  • endpoint (type: string ; configure a custom endpoint)
  • region (type: string ; defaults to us-east-1 if not specified)
  • forcePathStyle (type: boolean; set to true if you want to use a custom endpoint)

This returns a Readable stream that contains the content of the requested object.

Upload data to S3

To put a stream into a S3 bucket, you will need to first write the stream to a file and then use putObject to upload the file to S3.

Direct stream to S3 upload is not supported.