@universal-packages/storage-s3
v1.3.3
Published
Aws s3 engine for universal-storage
Downloads
44
Readme
Storage S3
S3 engine for universal-storage.
Install
npm install @universal-packages/storage-s3
npm install @universal-packages/storage
S3Engine
Just pass this engine to the registry to enable it to use ready as the storage engine.
import { Storage } from '@universal-packages/universal-storage'
import { S3Engine } from '@universal-packages/universal-storage-s3'
const storage = new Storage({ engine: 's3', engineOptions: { region: 'us-east-1' } })
await registry.prepare()
Options
region
String``String
Default: 'us-east-1'
AWS region to use.bucket
String
AWS bucket to use.accessKeyId
String
Optional
AWS access key id.secretAccessKey
String
Optional
AWS secret access key.acl
String
Optional
AWS default ACL to use with every upload.
Typescript
This library is developed in TypeScript and shipped fully typed.
Contributing
The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.