typed-local-storage

A wrapper to provide type safe access to the localStorage and sessionStorage.

Installation

npm install typed-local-store
# or
yarn add typed-local-store

Usage

Create a schema of your desired storage structure:

interface Schema {
  counter: number;
  message: string;
  user: {
    id: string;
    name: string;
    email: string;
    isAdmin: boolean;
  };
  posts: string[];
}

Then create your storage using the defined schema:

import TypedLocalStore from 'typed-local-store';

const typedStorage = new TypedLocalStore<Schema>();

Options

The constructor can receive a options object to configure the store.

options

API

The API of typed-local-store mimics the Storage API except for one exception, the Storage APIs length property is implemented as a method.

getItem

The getItem method has three retrieval modes, whereas 'fail' is the default mode