@twin.org/blob-storage-connector-aws-s3 v0.0.1-next.6

TWIN Blob Storage Connector AWS S3

Blob Storage connector implementation using AWS S3.

Installation

npm install @twin.org/blob-storage-connector-aws-s3

Testing

The tests developed are functional tests and need an instance of AWS S3 up and running. To run AWS S3 locally using local stack:

docker run -p 4566:4566 -p 4510-4559:4510-4559 --name localstack -d localstack/localstack -e AWS_DEFAULT_REGION='eu-central-1' -e AWS_ACCESS_KEY_ID='test' -e AWS_SECRET_ACCESS_KEY='test' -e SERVICE='S3'

Afterwards you can run the tests as follows:

npm run test

Examples

Usage of the APIs is shown in the examples docs/examples.md

Reference

Detailed reference documentation for the API can be found in docs/reference/index.md

Changelog

The changes between each version can be found in docs/changelog.md