AWS S3 adapter for Nodestream
This adapter provides interface for Nodestream to transfer bytes between your app and Amazon S3 cloud storage.
npm install --save nodestream-s3
When configuring Nodestream instance, the only required option is the
bucket. The rest is optional and is passed along unmodified to the
AWS.S3() constructor. No default values are provided.
const Nodestream =const nodestream =adapter: 's3'config:// Required - cannot do anything without a bucket!bucket: 'my-s3-bucket'// The rest of the options is passed as-is to the AWS.S3() constructor// NOTE: You will probably need the AWS credentials here 😀accessKeyId: 'my-access-key-id'secretAccessKey: 'my-secret!'
When uploading files, you may specify a
name for the upload. Both are optional - if no
name is given, a random GUID will be generated.
You can also specify custom options for the
upload() method to specify options like ACL or part size for multipart uploads.
const file = fsnodestream
You can also specify options for the
getObject() method via
s3 object (this adapter's identity) in the third argument.
const dest = fsnodestream// Perhaps in an Express controller, you would pipe the file to the clientresresnodestream
This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.