Skip to content

Latest commit

 

History

History
160 lines (115 loc) · 3.98 KB

README.md

File metadata and controls

160 lines (115 loc) · 3.98 KB
Raw

This simple NestJS AWS S3 library allows you to use the AWS SDK v3 in a more friendly and familiar way by providing injectable services for managing things like buckets and objects.

NestJS Amazon S3 library

Installation

To install it simply run

yarn add @lab08/nestjs-s3

or

npm install @lab08/nestjs-s3

Usage

The S3 module support multiple ways to init it

The strait approach is simply calling S3Module.forRoot and specifying the region, access key id, and secret access key.

S3Module.forRoot({
  region: 'eu-west-1',
  accessKeyId: 'test',
  secretAccessKey: 'test',
});

However, there are times, when the configuration is loaded from a service or depends on other providers. This can be achieved using the S3Module.forRootAsync.

S3Module.forRootAsync({
  useFactory: () =>
    new Promise((resolve) => {
      resolve({
        region: 'eu-west-1',
        accessKeyId: 'test',
        secretAccessKey: 'test',
      });
    }),
});

Here is also an example, that uses the @nestjs/config.

S3Module.forRootAsync({
  useFactory: (config) => {
    return config.get<S3Config>('config-key');
  },
  inject: [ConfigService],
  import: [ConfigModule],
});

Documentation

If you want to read more on the usage, you can check the documentation

Contributing

  1. Fork it
  2. Install dependencies (yarn install)
  3. Create your feature branch (git checkout -b feature/my-feature)
  4. Commit your changes (git commit -am 'Added some feature')
  5. Test your changes (yarn test)
  6. Push to the branch (git push origin feature/my-feature)
  7. Create a new Pull Request

Testing

We use Jest to write tests. Run our test suite with this command:

yarn test

Code Style

We use Prettier and tslint to maintain code style and best practices. Please make sure your PR adheres to the guides by running:

yarn format

and

yarn lint

Authors and main contributors

Docs

If you want to read the

Development

  1. Clone the repo
  2. Run yarn install
cd nestjs-s3
yarn install

Running tests

yarn test

License

MIT License

Copyright (c) 2022 LAB08

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.