nodestream-s3
AWS S3 adapter for Nodestream
Identity:: s3
Description
This adapter provides interface for Nodestream to transfer bytes between your app and Amazon S3 cloud storage.
Usage
Installation
npm install --save nodestream-s3
Configuration
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!'
Usage
Uploading
When uploading files, you may specify a directory
and 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
Downloading
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
License
This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.