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

nodestream-filesystem

v0.7.0

Published

Local filesystem adapter for Nodestream

Downloads

16

Readme

Filesystem nodestream-filesystem

NPM Version Build Status Coverage Status Documentation Status Built with GNU Make

Local filesystem adapter for Nodestream

Identity: filesystem

API docs

Description

This adapter provides interface for Nodestream to transfer bytes between your app and the local filesystem storage on which the app runs.

Usage

Installation

npm install --save nodestream-filesystem

Configuration

This adapter has only one confuguration option - root - a path to a folder where Nodestream should expect to find/write your files to. If you do not provide this option, then Nodestream will try its best to determine that path for you:

  • By checking the presence of require.main and using it
  • By using the current working directory

In all these default cases, the target folder will be named .storage. If it does not exist, it will be created on first write.

Even with these defaults, you should always explicitly state where Nodestream should put your files. It's the only way to guarantee that you will not spend hours searching through your project's files trying to figure out where the hell did that file go. 😀

const Nodestream = require('nodestream')
const nodestream = new Nodestream({
  adapter: 'filesystem',
  config: {
    // You MUST provide either an absolute path or nothing at all
    // You can use array notation, the parts will be `path.join()`ed for you
    root: [__dirname, '.storage']
  }
})

License

This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.