aws-s3-utils
What is this?
Node.js library providing high-level promise-based wrapper for convenient AWS S3 capabilities such as downloading an S3 object as a string or directly to a file.
Installation
yarn add aws-s3-utils
Usage
Download to String
Downloading an S3 object to a string is implementing streams behind the scenes, and works as simple as defining a Map for the options and invoking the downloadToString
promise:
const awsS3Util = const params = paramsparams awsS3Util
You can also pass a key that sets a character byte limit on the length of the string:
params
Download to File
Downloading an S3 object to a file is also implemented using streams and works by invoking the downloadToFile
promise.
The downloadToFile
supports the following download
settings on the provided Map options:
- If
tempDirectory
is specified then the library will create a unique temporary directory inside thetempDirectory
directory and download the file there. - If
destFile
is specified then the downloaded file wil be named using this filename. - If
destDirectory
is specified then the downloaded file will be placed directly inside this directory without creating any upper level unique directory. If both this option andtempDirectory
are specified then this option takes precedence.
const awsS3Util = const params = paramsparamsparams awsS3Util
Tests
Project tests:
yarn test
Project linting:
yarn lintyarn lint:fix
View Coverage
yarn coverage:view
Developer Commit
The project uses the commitizen tool for standardizing changelog style commit messages so you should follow it as so:
git add . # add files to staging yarn commit # use the wizard for the commit message