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

@voilab/vmol-s3

v0.7.1

Published

Moleculer mixin for S3 object storage

Downloads

55

Readme

vmol-s3

Moleculer mixin adding s3 access to the local service.

Configuration

Settings can be provided by the service or using enviroment variables.

settings: {
    s3: {
        keyId: process.env.S3_STORAGE_KEYID,
        key: process.env.S3_STORAGE_KEY,
        region: process.env.S3_STORAGE_REGION,
        endpoint: process.env.S3_STORAGE_ENDPOINT,
        container: process.env.S3_STORAGE_CONTAINER,
        delimiter: process.env.S3_STORAGE_DELIMITER
    }
}

Usage

To enable, add the middleware to your services.

const S3Service = require('vmol-s3');

module.exports = {
    name: 'myservice',

    /**
     * Mixins
     */
    mixins: [ S3Service ],
};

API

s3upload(stream, options)

s3uploadFromRequest(req, options)

s3stat(name, options)

s3getStream(name, offset, length, options)

s3getBuffer(name, options)

s3streamToKoa(ctx, name, options)

s3getTag(source, options)

s3move(source, destination, options)

s3copy(source, destination, options)

s3listFiles(names, options)

s3remove(name, options)

s3removeFiles(names, options)

s3addClient(name, options)

s3withStaticUrl(prefix, data, fields)

Advanced configuration

Multiple containers in a single client connection

You may need access to more than one container. In this case, you can specify it in all API methods, inside the options object.

this.s3upload(stream, { container: 'other-container' });

If omitted, the settings.s3.container value will be used.

Multiple client connections

You may need to work with different client connections to different buckets. Behind the scene, the s3 settings will be used to create a specific connection.

You can add a new client connection this way:

// best practice is to add your client in started() moleculer method
started() {
    this.s3addClient('some-name', {
        keyId: process.env.PRIVATE_STORAGE_KEYID,
        key: process.env.PRIVATE_STORAGE_KEY,
        region: process.env.PRIVATE_STORAGE_REGION,
        endpoint: process.env.PRIVATE_STORAGE_ENDPOINT,
        container: process.env.PRIVATE_STORAGE_CONTAINER
    });
}

// upload with the new specific client
this.s3upload(stream, { client: 'some-name' });

// upload with main client using settings.s3
this.s3upload(stream);
// or explicitly
this.s3upload(stream, { client: '' }); // or any falsy value

Mulitple containers in a specific client connection

You can specify both client and container if you have a complex set of connections and containers.

this.s3upload(stream, {
    client: 'some-name',
    container: 'some-container'
});

By default, it is always the container defined in client connection configuration which id used.