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

@socketsupply/json-store

v0.2.0

Published

Socket Supply Runtime plugin: JSON-based storage (file-system) with localStorage-compatible API

Downloads

5

Readme

JSONStore (Socket Supply Module)

Provides simple key-val storage of JSON-compatiable values, backed by the device's filesystem (via Socket Supply's runtime fs module).

This module provides an API that's similar to the browser localStorage API, except that it operates asynchronously (because of the underlying file system operation asynchrony). Other than the use of promises (await, etc), it should be familiar if you've worked with localStorage before.

JSON Serialization/Deserialization

One additional important difference between JSONStore and localStorage: non-primitive (object) values are automatically JSON serialized/de-serialized; the whole data store is serialized to a JSON string, written to a text file (./.store.json).

As such, JSONStore.setItem('customer', { id: 123, name: '..' }) works without needing to first serialize the object value with JSON.stringify(..). Likewise, JSONStore.getItem('customer') will return the already deserialized object, without needing to use JSON.parse(..).

API

getItem(name): returns a promise for the value (if any) in the store that's associated with name property name (string); resolves to undefined if not found

setItem(name, value): sets a value value (JSON-compatible) at the name property in the store; returns a promise, with true on success or false otherwise

removeItem(name): removes the property named name (if any) from the store; returns a promise, with true on success or false otherwise

clear(): removes all entries from the store; returns a promise, with true on success or false otherwise

Usage

import JSONStore from `@socketsupply/json-store`

JSONStore.setItem('zipcode', 78739)     // Promise<true>

JSONStore.getItem('zipcode')   // Promise<78739>

JSONStore.removeItem('zipecode')    // Promise<true>

JSONStore.getItem('zipcode')    // Promise<undefined>

JSONStore.setItem('customer', { id: 123, name: 'Kyle' })    // Promise<true>

JSONStore.getItem('customer')   // Promise<{ id: 123, name: 'Kyle' }>

JSONStore.clear()   // Promise<true>

ESM

This module is provided in ES6-compatible ESM. It exports both a default export of the JSONStore object, as shown above, as well as each API member (setItem(..), getItem(..), etc) as a named export.

License

All code and documentation are (c) 2023 Socket Supply Co and released under the MIT License. A copy of the MIT License is also included.