polystore 0.15.12 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/index.d.ts +82 -0
  2. package/index.js +809 -0
  3. package/package.json +20 -23
  4. package/readme.md +327 -52
  5. package/src/clients/Client.js +0 -7
  6. package/src/clients/api.js +0 -30
  7. package/src/clients/cloudflare.js +0 -56
  8. package/src/clients/cookie.js +0 -51
  9. package/src/clients/etcd.js +0 -29
  10. package/src/clients/file.js +0 -70
  11. package/src/clients/folder.js +0 -49
  12. package/src/clients/forage.js +0 -29
  13. package/src/clients/index.js +0 -25
  14. package/src/clients/level.js +0 -40
  15. package/src/clients/memory.js +0 -19
  16. package/src/clients/redis.js +0 -51
  17. package/src/clients/storage.js +0 -25
  18. package/src/index.d.ts +0 -209
  19. package/src/index.js +0 -278
  20. package/src/server.js +0 -81
  21. package/src/utils.js +0 -47
package/index.d.ts ADDED
@@ -0,0 +1,82 @@
1
+ type Options = {
2
+ expires?: number | null | string;
3
+ };
4
+ type StoreData<T extends Serializable = Serializable> = {
5
+ value: T;
6
+ expires: number | null;
7
+ };
8
+ type Serializable = string | number | boolean | null | (Serializable | null)[] | {
9
+ [key: string]: Serializable | null;
10
+ };
11
+ interface ClientExpires {
12
+ EXPIRES: true;
13
+ promise?: Promise<any>;
14
+ test?: (client: any) => boolean;
15
+ get<T extends Serializable>(key: string): Promise<T | null> | T | null;
16
+ set<T extends Serializable>(key: string, value: T, options?: Options): Promise<any> | any;
17
+ iterate<T extends Serializable>(prefix: string): AsyncGenerator<[string, T], void, unknown> | Generator<[string, T], void, unknown>;
18
+ add?<T extends Serializable>(prefix: string, value: T, options?: Options): Promise<string>;
19
+ has?(key: string): Promise<boolean> | boolean;
20
+ del?(key: string): Promise<any> | any;
21
+ keys?(prefix: string): Promise<string[]> | string[];
22
+ values?<T extends Serializable>(prefix: string): Promise<T[]> | T[];
23
+ entries?<T extends Serializable>(prefix: string): Promise<[string, T][]> | [string, T][];
24
+ all?<T extends Serializable>(prefix: string): Promise<Record<string, T>> | Record<string, T>;
25
+ clear?(prefix: string): Promise<any> | any;
26
+ clearAll?(): Promise<any> | any;
27
+ close?(): Promise<any> | any;
28
+ }
29
+ interface ClientNonExpires {
30
+ EXPIRES: false;
31
+ promise?: Promise<any>;
32
+ test?: (client: any) => boolean;
33
+ get<T extends Serializable>(key: string): Promise<StoreData<T> | null> | StoreData<T> | null;
34
+ set<T extends Serializable>(key: string, value: StoreData<T> | null, options?: Options): Promise<any> | any;
35
+ iterate<T extends Serializable>(prefix: string): AsyncGenerator<[string, StoreData<T>], void, unknown> | Generator<[string, StoreData<T>], void, unknown>;
36
+ add?<T extends Serializable>(prefix: string, value: StoreData<T>, options?: Options): Promise<string>;
37
+ has?(key: string): Promise<boolean> | boolean;
38
+ del?(key: string): Promise<any> | any;
39
+ keys?(prefix: string): Promise<string[]> | string[];
40
+ values?<T extends Serializable>(prefix: string): Promise<StoreData<T>[]> | StoreData<T>[];
41
+ entries?<T extends Serializable>(prefix: string): Promise<[string, StoreData<T>][]> | [string, StoreData<T>][];
42
+ all?<T extends Serializable>(prefix: string): Promise<Record<string, StoreData<T>>> | Record<string, StoreData<T>>;
43
+ clear?(prefix: string): Promise<any> | any;
44
+ clearAll?(): Promise<any> | any;
45
+ close?(): Promise<any> | any;
46
+ }
47
+ type Client = ClientExpires | ClientNonExpires;
48
+
49
+ declare class Store<TDefault extends Serializable = Serializable> {
50
+ #private;
51
+ PREFIX: string;
52
+ promise: Promise<Client> | null;
53
+ client: Client;
54
+ constructor(clientPromise?: any);
55
+ add(value: TDefault, options?: Options): Promise<string>;
56
+ add<T extends TDefault>(value: T, options?: Options): Promise<string>;
57
+ set(key: string, value: TDefault, options?: Options): Promise<string>;
58
+ set<T extends TDefault>(key: string, value: T, options?: Options): Promise<string>;
59
+ get(key: string): Promise<TDefault | null>;
60
+ get<T extends TDefault>(key: string): Promise<T | null>;
61
+ has(key: string): Promise<boolean>;
62
+ del(key: string): Promise<string>;
63
+ [Symbol.asyncIterator](): AsyncGenerator<[string, TDefault], void, unknown>;
64
+ [Symbol.asyncIterator]<T extends TDefault>(): AsyncGenerator<[
65
+ string,
66
+ T
67
+ ], void, unknown>;
68
+ entries(): Promise<[string, TDefault][]>;
69
+ entries<T extends TDefault>(): Promise<[string, T][]>;
70
+ keys(): Promise<string[]>;
71
+ values(): Promise<TDefault[]>;
72
+ values<T extends TDefault>(): Promise<T[]>;
73
+ all(): Promise<Record<string, TDefault>>;
74
+ all<T extends TDefault>(): Promise<Record<string, T>>;
75
+ clear(): Promise<void>;
76
+ prefix(prefix?: string): Store<TDefault>;
77
+ close(): Promise<void>;
78
+ }
79
+ declare function createStore(): Store<Serializable>;
80
+ declare function createStore<T extends Serializable = Serializable>(client?: any): Store<T>;
81
+
82
+ export { type Client, type Serializable, Store, createStore as default };