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

imfs

v0.1.0

Published

An in-memory filesystem-like data structure.

Downloads

837

Readme

imfs

An in-memory filesystem-like data structure.

Combine this library with immer to support immutability via structural sharing. This is an effective way to store the entire history of a filesystem in a low-memory way, or when you want an in-memory filesystem that works well with React's memoization and reducers.

npm install --save imfs

OR

yarn add imfs

API

There are 4 categories of functions:

  1. Volume: A collection of filesystem-like APIs e.g. readFile, writeFile. These functions let you use paths to traverse a hierarchy of file nodes. This is likely the main thing you'll use.
  2. Nodes: Lower-level functions for working with file nodes.
  3. Entries: A couple small helpers for traversing the volume. Useful when combined with a tree traversal library like tree-visit.
  4. path: A subset of node's path API. Only supports Unix-style paths.

Usage

To start, create a volume. In TypeScript, each volume has 2 type parameters: the Data type that will be used to store file data, and optionally any Metadata that should be stored alongside each file and directory.

import { Volume } from 'imfs'

// Initialize a volume where files are stored as strings, with no metadata.
const root = Volume.create<string>()

// Write the string 'Hello, world!' into the file 'e.txt'
Volume.writeFile(root, '/a/b/c/d/e.txt', 'Hello, world!', {
  makeIntermediateDirectories: true,
})

// Read the string stored in 'e.txt'
const data = Volume.readFile(updated, '/a/b/c/d/e.txt')

console.log(data) // $> Hello, world!

For a more realistic filesystem, use a type like Buffer as the Data type (to support binary data), and a type like node's fs.Stats as the Metadata type (for permissions, timestamps, etc).

Volume

  • create
  • getMetadata
  • getNode
  • getPathComponents
  • makeDirectory
  • readDirectory
  • readFile
  • removeFile
  • setMetadata
  • setNode
  • writeFile

Nodes

  • createDirectory
  • createFile
  • getChild
  • getMetadata
  • hasChild
  • isDirectory
  • isFile
  • readDirectory

Entries

  • createEntry
  • getEntries

path

  • basename
  • dirname
  • extname
  • join
  • normalize
  • sep