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

quick-storage

v2.4.3

Published

File system key/value storage.

Downloads

35

Readme

QuickStorage

Simple key/value storage module with persistency on file system.

This module used to work in the browser with IndexedDB, more info can be found here https://github.com/BonneVoyager/quick-storage/tree/v1.4.0.

Installation

npm install --save quick-storage

Usage

QuickStorage expects an argument - a path to store data in the file system (otherwise, it will throw).

import QuickStorage from 'quick-storage'
const myStorage = new QuickStorage(`${__dirname}/data`)

This will create ${__dirname}/data directory and store data in it. Each data key will be stored in separate file (key myKey will be store in file ${__dirname}/data/myKey). File content is stringified on write, and parsed on read.

API

myStorage.set('myKey', { foo: 'bar' })
myStorage.has('myKey') // true
myStorage.get('myKey') // { "foo": "bar" }
myStorage.keys() // [ "foo" ]
myStorage.delete('myKey')
myStorage.isReady // false before onReady callback, and true afterwards
myStorage.onReady((fn) => {
  console.info('All previous data was read and I am ready for some work!')
})
myStorage.onError((err) => {
  console.error('My storage error:', err)
})
const obj = { foo: "bar" }
myStorage.proxy(obj, {
  preventExtensions: true, // whether to invoke Object.preventExtensions(obj)
  persistProps: [ 'foo' ]  // props which should keep the persistency
})

Few tips

  • please keep in mind that this module is intended to be used with small chunks of data (up to dozens of megabytes). All the data is stored in memory with Map cache object.
  • data is parsed between string and json. That means that this module works only with JSON objects.
  • when you create QuickStorage(__dirname + '/data'), the script will try to find and read data associated with __dirname + '/data' (read FS on the server). After it's read, storage object will call onReady function.
  • you can use a callback as a second argument for get function to force read the data from the FS, instead of Map cache object.

Test

npm run test

Changelog

CHANGELOG.md

License

MIT