Skip to content

jtviegas-sandbox/bucket-wrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Coverage Status

BUCKET WRAPPER

wrapper library for a bucket-like store, current implementation using aws s3

Installation

npm install @jtviegas/bucket-wrapper

Usage

required environment variables or configuration properties

  • BUCKETWRAPPER_AWS_REGION
  • BUCKETWRAPPER_AWS_ACCESS_KEY_ID
  • BUCKETWRAPPER_AWS_ACCESS_KEY
  • for testing purposes: BUCKETWRAPPER_TEST: { bucket_endpoint: 'http://localhost:5000' }

code snippet example

let config = {
        BUCKETWRAPPER_AWS_REGION: 'eu-west-1'
        , BUCKETWRAPPER_AWS_ACCESS_KEY_ID: .....
        , BUCKETWRAPPER_AWS_ACCESS_KEY: .....
}

var bw = require('@jtviegas/bucket-wrapper')(config);

bw.listObjects = (bucket, bucket_key, (e,r) => {
    if(e){
        //...do your error handling
    }
    else {
    // ... do whatever you want
    }
});

Check the test folder in source tree.

Tests

npm test

Contributing

just help yourself and submit a pull request

About

...it's exactly that, a wrapper for a bucket-like store

Resources

License

Stars

Watchers

Forks

Packages

No packages published