https://github.com/taylorackley/lazy-s3
High level abstraction of s3 functions for lazy programmers.
https://github.com/taylorackley/lazy-s3
aws aws-s3 aws-sdk lazy nodejs
Last synced: about 1 year ago
JSON representation
High level abstraction of s3 functions for lazy programmers.
- Host: GitHub
- URL: https://github.com/taylorackley/lazy-s3
- Owner: TaylorAckley
- License: mit
- Created: 2017-02-18T04:36:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-20T01:46:00.000Z (over 9 years ago)
- Last Synced: 2025-04-17T23:21:20.825Z (about 1 year ago)
- Topics: aws, aws-s3, aws-sdk, lazy, nodejs
- Language: JavaScript
- Homepage:
- Size: 418 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Lazy S3
[](https://travis-ci.org/TaylorAckley/lazy-s3)
[](https://coveralls.io/github/TaylorAckley/lazy-s3)
Do you hate writing the same S3 operations multiple times like me? Well, let me save you about 15 minutes and give you some high level abstraction of common S3 operations.
- Get an object from S3
- Download an object from S3
- Get a pre-signed URL from S3
- Delete an object for S3.
- Generate a policy document for browser uploads.
## Advantages
- AWS Documentation can take forever to come through and figure out the arguments.
- Sets sensisble defaults.
- Makes you set a content-type.
- Error catching for missed params.
- Returns promises
## Installation
`npm i lazy-s3 --save`
## Usage
First, you must make sure the following environment variables are set.
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- AWS_BUCKET
Setting a bucket is optional. If you do set a bucket either through the options object or set it as an environment variable, it will act as the default bucket for all methods. This means that you don't need to pass a bucket argument to any of the methods when set. However, if you DO pass in a bucket as a parameter to a method, the argument will be used over the default bucket.
Lazy S3 exposes a class, `S3`, that takes a optional object of options. You can use [Foreman](https://www.npmjs.com/package/foreman) to load in a .env file containing the necessary options if you wish to not bother with setting the options in a object.
```javascript
// constructor
let s3 = new S3('my-default-bucket'); // or process.env.AWS_BUCKET. Setting either of these is essentially setting a default bucket.
// read a file and upload the contents to s3.
fs.readFile('input.png', (err, data) => {
if (err) {
return console.error(err);
}
// File as buffer, key, content-type, bucket. Bucket is optional if default bucket has been specified.
// Returns promise.
s3.upload(data, 'content/input.png', 'image/png', 'my-bucket')
.then((res) => console.log(res)) // res is the returned metadata from s3 detailing the created object.
.catch((err) => console.log(err));
});
// download data from S3 as a buffer and write to file file.
s3.download('content/output.png', 'my-bucket') // Key and Bucket. Like the above, bucket is optional.
.then((buffer) => {
fs.writefile('output.png', buffer, (err) => {
if(err) {
// handle error...
}
});
});
// Get a presigned url that lasts for x amount of minutes. Use this method to let users dowload private documents from your buckets. Defaults to 20 minutes if the 2nd argument is omitted or null.
s3.getSignedUrl('mygif.gif', 20, 'my-bucket')
.then((url) => console.log(url.url))
.catch((err) => console.log(err));
// Create a s3 polixy to be used with browser uploads
s3.createS3Policy('application/pdf', 'private', 'my-bucket')
.then((policy) => console.log(policy)) // returns object of policy information.
.catch((err) => console.log(err));
```
[Documentation](https://taylorackley.github.io/lazy-s3/)