This package has been deprecated

Author message:

unused

@bytesoftio/use-local-store
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

@bytesoftio/use-local-store

Installation

yarn add @bytesoftio/use-local-store or npm install @bytesoftio/use-local-store

Table of contents

Description

This package is built on top of @bytesoftio/use-store and provides an integration with localStorage. This way your application state can survive page reloads, etc. Check out the docs of the other package to find a more in depth guide.

Usage

createLocalStore

Since @bytesoftio/use-store is used underneath, stores produced by this and the other package are interchangeable. A store created by createLocalStore can be used with useStore from the other package.

import React from "react"
import { createLocalStore } from "@bytesoftio/use-local-store"
import { useStore } from "@bytesoftio/use-store"

// state shared between components and services, cached in localStorage
const authStore = createLocalStore("auth", { token: "abcde" })

const Component = () => {
  const [state, setState, addState, resetState] = useStore(authStore)
  // local component state, created through an initializer function, cached in localStorage
  const [persistentState, setPersistentState] = useStore(() => createLocalStore("counter", {count: 0}))

  const increment = () => setPersistentState({count: persistentState.count + 1})

  return (
    <div>
      <span>Auth token: {state.token}</span>
      <button onClick={increment}>{persistentState.count}</button>
    </div>
  )
}

Readme

Keywords

none

Package Sidebar

Install

npm i @bytesoftio/use-local-store

Weekly Downloads

0

Version

1.0.2

License

MIT

Unpacked Size

5.13 kB

Total Files

14

Last publish

Collaborators

  • maximkott