@adil-01/persistent-state

1.0.2 • Public • Published

persistent-state

Persistent state for react and next js application with client and server side rendering capabilities

Setup

Installation

In your terminal type.

npm i @adil-01/persistent-state

In your package.json file you can view the new added package @adil-01/persistent-state

Usage

usePersistServer takes 3 arguements.

  • key : name of the state in your project must be a uniquie key.
  • dafaultVal : Intial value or default value where usePersistServer falls down if state is not persisted yet.
  • duration : Expiry in minutes upto which usePersistServer state is persisted.

In your react or next js project import the custom persistent hook

import { usePersistServer } from '@adil-01/persistent-state';

Calling the persistent state hook in your required file

const [persistedState, setPersistedState] = usePersistServer('my_string', '', 5); 

persistedState with name my_string can store string as we given default value as empty string and it will persist for 5 minutes

Updating new value is same as using normal useState in react

setPersistedState('new_string');

Examples

Datatype - Number

const [persistedState, setPersistedState] = usePersistServer('my_number', 100, 7); 

persistedState with name my_number can store number as we given default value as 100 and it will persist for 7 minutes

Datatype - Array

const [persistedState, setPersistedState] = usePersistServer('my_array', [], 15); 

persistedState with name my_array can store array as we given default value as [] and it will persist for 15 minutes


JavaScript objects are not supported for usePersistServer as a state in current version, will be supported in newer versions

Package Sidebar

Install

npm i @adil-01/persistent-state

Weekly Downloads

3

Version

1.0.2

License

MIT

Unpacked Size

5.25 kB

Total Files

4

Last publish

Collaborators

  • adil-01