saurabh2608 / loopback4-s3

A loopback4 extension for AWS S3 integration

loopback4-s3

A simple loopback-next extension for AWS S3 integration in loopback applications.

Install

npm install loopback4-s3

Usage

In order to use this component into your LoopBack application, please follow below steps.

• Add component to application and provide access keys and other s3 initialization configuration details via AWSS3Bindings.Config binding as mentioned below. You can add any of the options mentioned here.

this.bind(AWSS3Bindings.Config).to({
  accessKeyId: process.env.AWS_ACCESS_KEY_ID,
  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
  region: process.env.AWS_REGION,
  signatureVersion: process.env.AWS_SIGNATURE,
} as AwsS3Config);
this.component(AwsS3Component);

• After this, you can just inject the S3 provider across application.

import * as AWS from 'aws-sdk';

@inject(AWSS3Bindings.AwsS3Provider) s3: AWS.S3,

Feedback

If you've noticed a bug or have a question or have a feature request, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please star it. Appreciation really helps in keeping this project alive.

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Developing

For development guidelines, refer here

Code of conduct

Code of conduct guidelines here.

License

MIT