km-storage is a Typescript library for use Local Storage.
Use the package manager npm to install km-storage.
npm install km-storageimport storage from "km-storage";
import { z } from "zod";
let schema = z.object({
gender: z.union([z.literal("F"), z.literal("M")]),
isDark: z.boolean(),
userInfo: z.object({
name: z.string(),
age: z.number(),
email: z.string().email(),
}),
});
let localDB = storage.install(schema, { prefix: "db", mode: "sessionStorage" });
// unions examples
// ----------------------------
localDB.create("gender", "M"); // validator trow error if entry is not equal with "M" or "F"
localDB.use("gender"); // return "M" // return string
localStorage.getItem("db:gender"); // return "M" // return string
// -----------------------------
// boolean examples
// ----------------------------
localDB.create("isDark", true);
localDB.use("isDark"); // return true ( type is boolean )
localStorage.getItem("db:isDark"); // return "true" ( type is string )
// -----------------------------
// object examples
// ----------------------------
localDB.create("userInfo", { name: "Komeil", age: 26, email: "[email protected]" });
localDB.use("userInfo"); // return { ... } ( type is Object )
localStorage.getItem("db:isDark"); // return "{ ... }" ( type is string )
// -----------------------------Required Dependensies is ZOD