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

@ribeirolabs/local-storage

v3.1.1

Published

Local storage helper for set/get values, with value conversion

Downloads

1,534

Readme

@ribeirolabs/local-storage

Local storage helper for set/get values, with value conversion.

Usage

setLocalStorage (name, value) => void

Sets name with value in localStorage, it converts everything but strings with JSON.stringify so objects and arrays are stored correctly.

import { setLocalStorage } from '@ribeirolabs/local-storage';

setLocalStorage('person', { name: 'Jhon' });
setLocalStorage('active', true);
setLocalStorage('ids', [1, 2]);

getLocalStorage (name, fallback) -> value

Returns the value from localStorage or fallback if it's not present.

LocalStorage stores the values as a string, this function converts the value to the correct type.

import { getLocalStorage } from '@ribeirolabs/local-storage';

getLocalStorage('person', { name: 'default' }) // { name: 'Jhon' }
getLocalStorage('active', false) // true
getLocalStorage('ids', []) // [1, 2]
getLocalStorage('missing', 'use-me') // "use-me"

removeLocalStorage (name) -> void

No magic here, it removes name from localStorage.

React

useLocalStorage (name, fallback) -> [value, setValue]

Behaves like useState, but setValue updates the value in localStorage.

import { useLocalStorage } from '@ribeirolabs/local-storage/react';

function Component() {
  // `value` will be synced in localStorage
  const [value, setValue] = useLocalStorage('name', 'Jhon Doe');

  return (
    <input name="name" value={value} onChange={e => setValue(e.target.value)} />
  );
}

useSetLocalStorage (name, value) -> void

Use this when you need to sync the value into localStorage on every change.

import { useState } from 'react';
import { useLocalStorage } from '@ribeirolabs/local-storage/react';

function Component() {
  const [value, setValue] = useState('Jhon Doe');

  // updates `name` on localStorage everytime the `value` changes
  useSetLocalStorage('name', value);

  return (
    <input name="name" value={value} onChange={e => setValue(e.target.value)} />
  );
}

Browser

index.browser.js

It adds a global ribeirolabs.localStorage with all the methods.

<script src="https://unpkg.com/@ribeirolabs/local-storage/index.browser.js"></script>

<script>
  ribeirolabs.localStorage.setLocalStorage('name', 'John Doe');

  console.log(
    ribeirolabs.localStorage.getLocalStorage('name', '')
  );

  ribeirolabs.localStorage.removeLocalStorage('name');
</script>

index.mjs

To work with modules

<script type="module">
  import { setLocalStorage, getLocalStorage } from "https://unpkg.com/@ribeirolabs/local-storage/index.mjs";

  setLocalStorage('name', 'John Doe');

  console.log(
    getLocalStorage('name', '')
  );
</script>