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

@smcloudstore/generic-s3

v0.2.0

Published

Generic S3-compatible library for SMCloudStore

Downloads

37

Readme

@smcloudstore/generic-s3

This package is a provider for SMCloudStore, for a generic S3-compatible provider, including AWS S3. SMCloudStore is a lightweight Node.js module that offers a simple API to interact with the object storage services of multiple cloud providers.

Please refer to the main package for the SMCloudStore documentation and instructions on how to use it.

Provider-specific considerations

There are a few provider-specific considerations for the GenericS3 provider.

Connection argument

When initializing the GenericS3 provider, the connection argument is an object with:

  • connection.endPoint: string representing the endpoint of the server to connect to; for AWS S3, set this to s3.amazonaws.com and the library will pick the correct endpoint based on the connection.region argument (default: 'us-east-1')
  • connection.accessKey: string containing the access key (the "public key")
  • connection.secretKey: string containing the secret key
  • connection.useSSL (optional): boolean that will force the connection using HTTPS if true (default: true)
  • connection.port (optional): number representing the port to connect to; defaults to 443 if useSSL is true, 80 otherwise
  • connection.region (optional): string containing the AWS region to use, useful for connecting to AWS S3

Example:

// Require the package
const SMCloudStore = require('smcloudstore')

// Complete with the connection options for GenericS3
const connection = {
    endPoint: 'storage.cloudprovider.com',
    accessKey: 'PUBLIC_KEY_HERE',
    secretKey: 'SECRET_KEY_HERE',
}

// Return an instance of the GenericS3Provider class
const storage = SMCloudStore.create('generic-s3', connection)

Using pre-signed URLs

In the method storage.presignedPutUrl(container, path, [options], [ttl]), the Generic S3 provider ignores the options argument, which has no effect on the generated tokens.

Accessing the Minio library

The Generic S3 provider is built on top of the Minio JavaScript client, which is exposed by calling storage.client().

You can use the object returned by this method to perform low-level operations using the Minio client.