https://github.com/bigbeno37/zod-localstorage

A Typescript library to allow typesafe access to localstorage using schema validation from Zod
https://github.com/bigbeno37/zod-localstorage

Last synced: 4 days ago
JSON representation

A Typescript library to allow typesafe access to localstorage using schema validation from Zod

• Host: GitHub
• URL: https://github.com/bigbeno37/zod-localstorage
• Owner: bigbeno37
• License: mpl-2.0
• Created: 2022-02-15T05:48:47.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-18T07:44:49.000Z (over 2 years ago)
• Last Synced: 2024-11-04T23:20:28.936Z (12 days ago)
• Language: TypeScript
• Size: 116 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zod - `zod-localstorage` - A Typescript library to allow typesafe access to localstorage using schema validation from Zod. (Other)

README

        
# zod-localstorage

A Typescript library to allow typesafe access to localstorage using schema validation from Zod

## Usage

Create an object mapping every key to appear in localStorage to a Zod schema:

```ts

const TodoItems = z.array(z.object({

    name: z.string(),

    completed: z.boolean()

}));

const LocalStorageKeys = {

    TODO_ITEMS: TodoItems

};

```

Create a `ZodLocalStorage` instance using this object:

```ts

const Storage = new ZodLocalStorage(LocalStorageKeys);

```

To retrieve items, first verify that the retrieved item matches the given schema:

```ts

const validationResult = Storage.getItem("TODO_ITEMS");

if (!validationResult.success) {

    // log error, show notification, etc.

    return;

}

// Validation must be successful here

const { data } = validationResult; // Will be of type Array<{ name: string, completed: boolean }>

```

If you'd prefer a more traditional try-catch approach, use `ZodLocalStorage.getItemOrThrow`:

```ts

try {

    const validationResult = Storage.getItem("TODO_ITEMS");

    // Validation must be successful here

    const { data } = validationResult; // Will be of type Array<{ name: string, completed: boolean }>

} catch (e) {

    // handle error

    return;

}

```

To set items, use `ZodLocalStorage.setItem()`. NOTE: There is no need to use JSON.stringify for the value; it will automatically be called on the given value. 

```ts

const todoItems = [{ name: "Write some code", completed: false }];

Storage.setItem("TODO_ITEMS", todoItems);

```

## FP (Functional Programming) Module

For those who would prefer a more functional approach, `zod-localstorage` also comes with module that is more suited to a functional style, and uses the popular `purify-ts` library. As prior, create an object containing storage keys mapped to Zod schemas:

```ts

import {generateAccessor} from "zod-localstorage/fp";

const TodoItems = z.array(z.object({

    name: z.string(),

    completed: z.boolean()

}));

const LocalStorageKeys = {

    TODO_ITEMS: TodoItems

};

const getKey = generateAccessor(LocalStorageKeys);

const todoItems = getKey("TODO_ITEMS");

todoItems.setItem([ { name: "Learn Haskell", completed: false } ]); // Sets the "TODO_ITEMS" key in localStorage to the given value

const result = todoItems.getItem(); // Currently of type Either

todoItems.clear(); // Clears the todo items from local storage

```