ts-store

ts-store is a simple key-value store interface for TypeScript. The main use case is for library authors to allow users to provide their own store implementation.

The goals of this project are:

• Provide a simple, reusable interface for store implementations
• Provide modern JS/TS experience (e.g. async/await, promises, etc.)
• Stores can be implemented for a wide range platforms (e.g. browser, node, etc.)
• Stores can be implemented for a wide range of storage types (e.g. memory, disk, mongo, localstorage, etc.)

Creating a Store Implementation

To create a store implementation, implement the Store interface.

Class Example

1import { Store } from "ts-store";
2
3class MyStore implements Store {
4  get(key: string): Promise<any> {
5    // ...
6  }
7
8  set(key: string, value: any): Promise<void> {
9    // ...
10  }
11
12  delete(key: string): Promise<void> {
13    // ...
14  }
15}

Object Example

1import { Store } from "ts-store";
2
3const myStore: Store = {
4  get(key: string): Promise<any> {
5    // ...
6  },
7
8  set(key: string, value: any): Promise<void> {
9    // ...
10  },
11
12  delete(key: string): Promise<void> {
13    // ...
14  },
15};

See memory store for a more complete example.

Using a Store Implementation

Example Library

1// Library code
2import { Store } from "ts-store";
3
4function helloWorldLibrary(store: Store<string>) {
5  const saveHello = (value: string) => store.set("hello", value);
6  const getHello = () => store.get("hello");
7
8  return {
9    saveHello,
10    getHello,
11  };
12}
13
14// Use the library
15import { MemoryStore } from "ts-store"; // or your own store implementation
16
17async function main() {
18  const lib = helloWorldLibrary(new MemoryStore());
19
20  // save and read example
21  await lib.saveHello("world");
22  const hello = await lib.getHello();
23  console.log(hello); // { key: 'hello', value: 'world', createdAt: 1681318294496, updatedAt: 1681318294496 }
24
25  // wait a second
26  await new Promise((resolve) => setTimeout(resolve, 1000));
27
28  // update and read example
29  await lib.saveHello("gamer");
30  const hello2 = await lib.getHello();
31  console.log(hello2); // { key: 'hello', value: 'gamer', createdAt: 1681318294496, updatedAt: 1681318295500 }
32}
33main();