Please note that this library is about to be discontinued. Please prefer using the @mswjs/data package that provides data modeling capabilities, querying client, and data persistency. Thank you.

Storage

Data storage and persistency layer for testing JavaScript applications.

Features

Persistency

The values of a live storage are persisted in the session. In a browser that is achieved by sessionStorage.

Real-time synchronization

Updates to the storage are synchronized between all active clients in real time. In a browser that is achieved by using a BroadcastChannel to signal updates.

When to use?

When writing CRUD operations in tests;
When conducting local in-browser testing/debugging;
In combination with API mocking tools (i.e. MSW)

Get started

Install

$ npm install @mswjs/storage --save-dev

Create storage

import { LiveStorage } from '@mswjs/storage'

// Instantiate a new storage with a unique string key
// and initial value.
const posts = new LiveStorage('posts', [])

Update values

// Storage update is a function that derives the next value
// from the previous storage value.
posts.update((prevPosts) => prevPosts.concat({ title: 'Brave new world' });

Get value

posts.getValue() // [{ title: 'Brave new world' }]