npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

streamingo-aws-wrapper

v0.0.4

Published

AWS Wrapper to ease the use of aws npm module

Downloads

13

Readme

Streamingo-AWS-Wrapper

Streamingo-AWS-Wrapper is a wrapper for the aws-sdk that provides the easiest way to interact with Amazon Web Services. It is only built to be used with S3 as of now but the package will get its upgrades for other services over time.

For Github, visit https://github.com/oxabhishek/streamingo-aws-wrapper Branch master is current stable.

For reporting a bug, visit https://github.com/oxabhishek/streamingo-aws-wrapper/issues

Installation

The latest version of this package will work with as close as possible to the latest aws-sdk package.

npm install --save streamingo-aws-wrapper

Setup

Credentials:

Please make sure you have the ~/.aws/credentials file placed in the home directory. It only supports this way of adding credentials as of now. Please follow the provided documentation.

Requiring the module:

var SAW = require("streamingo-aws-wrapper");

S3

Uploading an object

Uploading an object is as simple as invoking the upload function from the SAW.s3 class.

SAW.s3.upload(bucketName, s3FilePath, content, contentType, callback);

The following are the details of the parameters:

  • bucketName - name of the S3 bucket where the file needs to be stored
  • s3FilePath - the hierarchical storage location path of the file
  • content - the actual content of the file
  • contentType - contentType of the file which defaults to binary/octet-stream which makes it downloadable when requested with the S3 URL. This when not passed and replaced with a callback function, it will be set to the default value. Eg:
SAW.s3.upload(
    "my-file-store",
    "/path/to/file.pdf",
    "<file content here>",
    function (err, resp) {}
);

Here we have'nt passed the contentType, hence it will default to binary/octet-stream

  • callback - on upload response, the callback will be invoked.

Removing an object

Deleting or removing an object is as simple as invoking the delete function from the SAW.s3 class.

SAW.s3.delete(bucketName, s3FilePath, callback);

The following are the details of the parameters:

  • bucketName - name of the S3 bucket where the file is stored
  • s3FilePath - the hierarchical storage location path of the file.

Example:

SAW.s3.delete(
    "my-file-store",
    "/path/to/file.pdf",
    function (err, resp) {/* handle callback response */}
);

Fetching an object

Fetching an object is as simple as invoking the fetch function from the SAW.s3 class.

SAW.s3.fetch(bucketName, s3FilePath, callback);

The following are the details of the parameters:

  • bucketName - name of the S3 bucket where the file is stored
  • s3FilePath - the hierarchical storage location path of the file.

Example:

SAW.s3.fetch(
    "my-file-store",
    "/path/to/file.pdf",
    function (err, resp) {/* handle callback response */}
);

This is all the module supports for now. Upgrades will be added over time.