@yeunoia/typed-storage

Type-safe storage library for TypeScript.

Installation

npm install @yeunoia/typed-storage

Usage

import { typedLocalStorage, typedSessionStorage } from '@yeunoia/typed-storage'

type User = { id: number; name: string }

const userStorage = typedLocalStorage<'user', User>()

userStorage.set('user', { id: 1, name: 'John' })
const user = userStorage.get('user') // User | null

With options:

const storage = typedLocalStorage<'settings', Settings>({
  options: {
    prefix: 'app',
    serializer: {
      serialize: (value) => btoa(JSON.stringify(value)),
      deserialize: (value) => JSON.parse(atob(value)),
    },
  },
})

API

typedLocalStorage<K, V>(config?) / typedSessionStorage<K, V>(config?)

| Method | Description | |---|---| | get(key) | V \| null | | set(key, value) | void | | remove(key) | void | | clear() | void | | keys() | K[] | | size() | number |

License

MIT