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

peerio-s3

v1.0.4

Published

Knox wrapper

Downloads

2

Readme

Fair Warning

This module supersedes ceph-s3, as I haven't been able to get my last contribution merged in (dropFile method). If you don't know what you're doing here, you probably just want to use knox or ceph-s3.

S3 compatible client wrapper based on ceph-s3/knox

npm install peerio-s3 -S

Usage

You could use a users.json file to your library's root directory, as the author suggests.

Or you could define a few environment variables starting your processes. Here's an exhaustive list, and their defaults:

export S3_STORE_PORT=6788
export S3_STORE_BUCKET_NAME=changeme
export S3_STORE_STYLE=path
export S3_STORE_HOST=127.0.0.1
export S3_STORE_PROTO=http

Otherwise just user ./lib/users or init function to pass your user configuration:

var S3Client = require('ceph-s3');

// pass users that you will use with this client
s3Client.init({

    myusername: {
        access_key: '',
        secret_key: ''
    },

    wonderfuluser: {
        access_key: '',
        secret_key: ''
    }

});

// can use anything that is supported by knox - https://github.com/Automattic/knox
var usernameClient = new S3Client({ bucket: 'mrusername' }, 'myusername', function (err) {
    if (err) {
        // failed to auth / connect / etc
        throw err;
    }

    console.log('Init complete');
});

// any errors during init will be suppressed in _.noop
// // access knox directly with mrwondeful.s3 if need be
var mrwondeful = newS3Client({ bucket: 'wonderful' }, 'mrwonderful');

// the only useful abstraction besides adding simple user management
var opts = {
    buffer: new Buffer('Contents of the file', 'utf-8'),
    filename: 'useless.txt',
    headers: {} // optional
};

mrwondeful.storeFile(opts, function (err, filename) {
    if (err) {
        throw err;
    }

    console.log(filename ? 'Uploaded %s' : 'Failed', filename);
});

var opts = { filename: 'useless.txt' };

mrwondeful.dropFile(opts, function (err) {
    if (err) {
        throw err;
    }

    console.log('Dropped file');
});