aws-s3-js

upload/delete files from an Amazon S3 bucket

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
aws-s3-js
001.3.29 months ago10 months agoMinified + gzip package size for aws-s3-js in KB

Readme

AWS S3 JS
npm GitHub commit activity (branch) NPM
Upload files to an Amazon S3 bucket using JavaScript.
Special note: aws-s3-js now works straight out of the box with react-scripts 5 and Webpack 5, even if you have not configured your app to polyfill Node Js core modules. aws-s3-js also works with react-scripts 4 straight out of the box.

Installation

To install the package, in your project run
npm install aws-s3-js

Then use a default import statement:
import awsS3Js from 'aws-s3-js'

aws-s3-js has browser support as well. Read below.

Usage

To get started, call the constructor using the below keys:
import awsS3Js from 'aws-s3-js'

const config = {
    bucketName: "<bucket-name>",
    region: "<bucket-region>",
    accessKeyId: "<your-accessKey>",
    secretAccessKey: "<your-secretAccessKey>"
}

const S3Client = new awsS3Js(config);

Please refer to aws-s3-jsgithub readme for full documentation and example usage.