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

@cyclic.sh/s3fs

v1.2.9

Published

Drop in replacement for Node.js fs library backed by AWS S3 with local filesystem fallback.

Downloads

1,709

Readme

@cyclic.sh/s3fs

Drop in replacement for the Node.js fs library backed by AWS S3. Use the same methods as fs and enjoy the convenience of S3 buckets without the hassle of AWS.

Discord CI semantic-release: angular

npm (scoped) node-current (scoped) code size @cyclic.sh/s3fs

Supported methods

@cyclic.sh/s3fs supports the following fs methods operating on AWS S3:

  • writeFile / writeFileSync
  • readFile / readFileSync
  • exists / existsSync
  • rm / rmSync
  • stat / statSync
  • unlink / unlinkSync
  • readdir / readdirSync
  • mkdir / mkdirSync
  • rmdir / rmdirSync

Example Usage

Installation

npm install @cyclic.sh/s3fs

Require in the same format as Node.js fs, specifying an S3 Bucket:

  • Callbacks and Sync methods:

    const fs = require('@cyclic.sh/s3fs')(S3_BUCKET_NAME)
  • Promises (for async/await functions):

    const fs = require('@cyclic.sh/s3fs/promises')(S3_BUCKET_NAME)
  • On Cyclic.sh

    • Alternatively, when using with cyclic.sh or if the environment variable CYCLIC_BUCKET_NAME is set to an S3 bucket name, initialization can happen without specifying a bucket:
      const fs = require('@cyclic.sh/s3fs') 
      or
      const fs = require('@cyclic.sh/s3fs/promises') 

Authentication

Authenticating the client:

  • cyclic.sh -

    • When deploying on cyclic.sh, credentials are already available in the environment.
    • The bucket name is also available under the CYCLIC_BUCKET_NAME variable.
    • Read more: Cyclic Environment Variables
  • Local Mode - When no credentials are available, the client will fall back to using fs and the local filesystem. A warning will show in the terminal.

  • Environment Variables - The internal S3 client will use AWS credentials if they are set in the local environment. Variables provided by Cyclic.sh may be found in "Data/Storage" tab in the user's Cyclic dashboard and will reset after 60 minutes.

    AWS_REGION
    AWS_ACCESS_KEY_ID
    AWS_SECRET_KEY
    AWS_SECRET_ACCESS_KEY
  • Client Credentials - The library also accepts standard S3 client parameters at initialization. For example:

    const fs = require('@cyclic.sh/s3fs')(S3_BUCKET_NAME, {
            region: ...
            credentials: {...}
        })

Using Methods

The supported methods have the same API as Node.js fs and can be written as follows:

  • Sync
      const fs = require('@cyclic.sh/s3fs')(S3_BUCKET_NAME)
      const json = JSON.parse(fs.readFileSync('test/_read.json'))
  • Callbacks
      const fs = require('@cyclic.sh/s3fs')(S3_BUCKET_NAME)
      fs.readFile('test/_read.json', (error,data)=>{
        const json = JSON.parse(data)
      })
  • Promises (async/await)
      const fs = require('@cyclic.sh/s3fs/promises')(S3_BUCKET_NAME)
      async function run(){
        const json = JSON.parse(await fs.readFile('test/_read.json'))
      }