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

hooked-on-storage

v0.1.0

Published

Store and rehydrate values in storage.

Downloads

2

Readme

Build Version Size License

A React hook to provide efficient access to properties in storage. It is compatible with the following storage adapters:

Install

This package can be installed from NPM.

$ yarn add hooked-on-storage

Usage

1. Create a stored property with createStorage

First, you'll need to declare a stored property:

import { createStorage } from "hooked-on-storage";

const counter = createStorage<number>({
  key: "count",
  adapter: localStorage,
  defaultValue: 0,
});

The counter provides some conveniences over using localStorage directly. Keep in mind that if you directly modify a value in localStorage or your components won't rerender.

Set the value

The value will automatically be serialized using JSON.stringify before being inserted into storage. You can customize this behavior by specifing the parse option.

await counter.set(1);

Get the current value

The value will automatically be deserialized using JSON.parse. You can customize this behavior by specifing the parse option.

If the value does not exist in storage, the defaultValue will be returned.

await counter.get();

Remove the value

await counter.remove();

Subscribe to changes

counter.onChange((value) => {
  console.log("changed:", value);
});

2: Setup the <StorageProvider />

At the top of your component tree, you'll need to define a provider for your storage.

import { StorageProvider, Hydrated } from "hooked-on-storage";

ReactDOM.render(
  <StorageProvider hydrate={[counter]}>
    <h1>Counter</h1>

    <Hydrated fallback={<p>Hydrating...</p>}>
      <Counter />
    </Hydrated>
  </StorageProvider>
);

Using the <Hydrated /> component is entirely optional. It allows us to render a loading screen while we load the values from storage.

Step 3: Use a stored property with useStorage

import { useStorage } from "hooked-on-storage";

const Counter = () => {
  const [count, setCount, hydrated] = useStorage(counter);
  const decrement = () => setCount(count - 1);
  const increment = () => setCount(count + 1);

  // Because we used `<Hydrated />` above, this will never be false.
  if (!hydrated) {
    return <p>Hydrating...</p>;
  }

  return (
    <div>
      <h4>{count}</h4>
      <button onClick={increment}>-</button>
      <button onClick={decrement}>+</button>
    </div>
  );
};