@bytesoftio/local-value

Installation

yarn add @bytesoftio/local-value or npm install @bytesoftio/local-value

Table of contents

• Description
• createLocalValue

Description

This library is built on top of the @bytesoftio/value package and provides an integration with localStorage. For a more in depth guide please check out the docs of the other package.

createLocalValue

Since this package is built on top of @bytesoftio/value, values produced by createLocalValue from this package and createValue from the other package are interchangeable. A value produced by this package can be consumed using the useValue hook of the @bytesoftio/use-value package.

import React from "react"
import { createLocalValue } from "@bytesoftio/local-value"
import { useValue } from "@bytesoftio/use-value"

const authValue = createLocalValue("authToken", "abcde")

const Component = () => {
  // use globally shared value, cached in localStorage
  const [authToken, setAuthToken, resetAuthToken] = useValue(authValue)
  // use local value, created through an initializer function, cached in localStorage
  const [persistentCounter, setPersistentCounter] = useValue(() => createLocalValue("counter", 1))

  const increment = () => setPersistentCounter(persistentCounter + 1)
  
  return (
    <div>
      <span>Auth token: {authToken}</span>
      <button onClick={increment}>{persistentCounter}</button>
    </div>
  )
}