examples

Author: Krzysztof Borowy

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         test-name: [lint, ts]
-        workspace: [default-storage-backend, core]
+        workspace: [default-storage-backend, api]
     steps:
       - name: Checkout
         uses: actions/checkout@v3

packages/api/example/ExampleExtension.ts

@@ -0,0 +1,17 @@
+import { StorageExtension } from "../src";
+
+export interface MyExampleExtension extends StorageExtension {
+  double: (num: number) => Promise<number>;
+
+  uppercase: (text: string) => string;
+
+  key: string;
+}
+
+export class ExampleExtension implements MyExampleExtension {
+  key = "my-example-storage";
+
+  double = async (num: number) => num * 2;
+
+  uppercase = (text: string): string => text.toUpperCase();
+}

packages/api/example/ExampleStorage.ts

@@ -0,0 +1,71 @@
+import { AsyncStorage, StorageKeys, StorageModel } from "../src";
+import { ExampleExtension, MyExampleExtension } from "./ExampleExtension";
+
+type MyModel = StorageModel<{
+  age: number;
+  name: string;
+  likes: boolean[];
+}>;
+
+// @ts-ignore
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+class ExampleStorage implements AsyncStorage<MyModel, MyExampleExtension> {
+  private storage: MyModel = {
+    age: null,
+    name: null,
+    likes: null,
+  };
+
+  getItem = async <K extends keyof MyModel>(key: K): Promise<MyModel[K]> => {
+    return this.storage[key];
+  };
+
+  setItem = async <K extends StorageKeys<MyModel>>(
+    key: K,
+    value: MyModel[K]
+  ): Promise<void> => {
+    this.storage[key] = value;
+  };
+
+  removeItem = async <K extends StorageKeys<MyModel>>(
+    key: K
+  ): Promise<void> => {
+    this.storage[key] = null;
+  };
+
+  getMany = async <K extends StorageKeys<MyModel>>(
+    keys: K[]
+  ): Promise<{ [k in K]: MyModel[k] }> => {
+    return keys.reduce((entries, key) => {
+      return {
+        ...entries,
+        [key]: this.storage[key] ?? null,
+      };
+    }, {} as { [k in K]: MyModel[k] });
+  };
+
+  setMany = async <K extends StorageKeys<MyModel>>(entries: {
+    [k in K]: MyModel[k];
+  }): Promise<void> => {
+    Object.entries(entries).forEach((entry) => {
+      const key = entry[0] as K;
+      this.storage[key] = entry[1] as MyModel[K];
+    });
+  };
+
+  removeMany = async <K extends StorageKeys<MyModel>>(
+    keys: K[]
+  ): Promise<void> => {
+    keys.forEach((k) => {
+      this.storage[k] = null;
+    });
+  };
+
+  clear = async (): Promise<void> => {
+    this.storage.age = null;
+    this.storage.name = null;
+    this.storage.likes = null;
+  };
+
+  ext: MyExampleExtension = new ExampleExtension();
+}