aykutkardas / lookie

You can store your data in LocalStorage without converting it to string. You can specify how long this data will be stored in LocalStorage. Lookie is a small package without dependencies and has type support.

Install

npm install lookie

yarn add lookie

Usage

Import

import lookie from "lookie";

Set

Type conversions are handled automatically.

So you can give values such as array, object, boolean, number, null or string.

lookie.set("list", [1, 2, 3, 4]);

lookie.set("data", { key: "value" });

lookie.set("count", 1234);

lookie.set("muted", true);

lookie.set("theme", "dark");

lookie.set("user", null);

Set with Expiry

lookie.set("key", value, "1M 15D 20h"); // 1 month 15 days 20 hours

According to this example, when you want to get this data 1 month 15 days 20 hours after setting, it will be deleted and you will not be able to access it.

Multiple Set

lookie.setAll({ key: value, otherKey: otherValue });

Multiple Set with Expiry

lookie.setAll({ key: value, otherKey: otherValue }, "1M 15D 20h");

Get

lookie.get("key");

Remove

lookie.remove("key");

Sync

Data is checked only when called and deleted if it has expired. Therefore, even if they have expired, they will continue to be stored until you call them. If you want LocalStorage to stay up to date, simply run this method.

Unless you have a special reason, you won't need it at all.

lookie.sync();

More Information About Expiry Support

Available Time Ranges

Examples

lookie.set("key", value, 1000); // 1 second

lookie.set("key", value, { s: 1 }); // 1 second

lookie.set("key", value, "1s"); // 1second