use-async-storage v1.2.0

use-async-storage

A React native hook using AsyncStorage, with some improvements, added functionality, and supports typescript.

API

useAsyncStorage is a function that takes two parameters:

• storageKey: This is a string used as the key the device will use to store the value in memory, so this will unique for majority of cases.
• defaultValue: This is the value the hook will return if nothing is found in storage. This can be a boolean, array, string or object.

And Returned from useAsyncStorageis a value, and a function to set the value, which will be persisted in the devices memory.

Usage

First time the hooks called

import { useAsyncStorage } from "use-async-storage";
const [value, setValue] = useAsyncStorage("someObject", {});

console.log(value); // {}

await setValue({ foo: "bar" });

console.log(value); // { foo: 'bar' }

And at some point later...

import { useAsyncStorage } from "use-async-storage";
const [value, setValue] = useAsyncStorage("someObject", {});

console.log(value); // { foo: 'bar' }

The value is now returned from the AsyncStore

Usage with Typescript

import { useAsyncStorage } from "use-async-storage";

const [value, setValue] = useAsyncStorage<number>("someObject", {}); // error!
const [value, setValue] = useAsyncStorage<number>("someObject", 1000); // ok!

await setValue({ foo: "bar" }); // error!
await setValue(123); // ok!