@gscdump/engine 0.33.9 → 0.35.1

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.
@@ -1,120 +0,0 @@
1
- type StorageValue = null | string | number | boolean | object;
2
- type WatchEvent = "update" | "remove";
3
- type WatchCallback = (event: WatchEvent, key: string) => any;
4
- type MaybePromise<T> = T | Promise<T>;
5
- type MaybeDefined<T> = T extends any ? T : any;
6
- type Unwatch = () => MaybePromise<void>;
7
- interface StorageMeta {
8
- atime?: Date;
9
- mtime?: Date;
10
- ttl?: number;
11
- [key: string]: StorageValue | Date | undefined;
12
- }
13
- type TransactionOptions = Record<string, any>;
14
- type GetKeysOptions = TransactionOptions & {
15
- maxDepth?: number;
16
- };
17
- interface DriverFlags {
18
- maxDepth?: boolean;
19
- ttl?: boolean;
20
- }
21
- interface Driver<OptionsT = any, InstanceT = any> {
22
- name?: string;
23
- flags?: DriverFlags;
24
- options?: OptionsT;
25
- getInstance?: () => InstanceT;
26
- hasItem: (key: string, opts: TransactionOptions) => MaybePromise<boolean>;
27
- getItem: (key: string, opts?: TransactionOptions) => MaybePromise<StorageValue>;
28
- /** @experimental */
29
- getItems?: (items: {
30
- key: string;
31
- options?: TransactionOptions;
32
- }[], commonOptions?: TransactionOptions) => MaybePromise<{
33
- key: string;
34
- value: StorageValue;
35
- }[]>;
36
- /** @experimental */
37
- getItemRaw?: (key: string, opts: TransactionOptions) => MaybePromise<unknown>;
38
- setItem?: (key: string, value: string, opts: TransactionOptions) => MaybePromise<void>;
39
- /** @experimental */
40
- setItems?: (items: {
41
- key: string;
42
- value: string;
43
- options?: TransactionOptions;
44
- }[], commonOptions?: TransactionOptions) => MaybePromise<void>;
45
- /** @experimental */
46
- setItemRaw?: (key: string, value: any, opts: TransactionOptions) => MaybePromise<void>;
47
- removeItem?: (key: string, opts: TransactionOptions) => MaybePromise<void>;
48
- getMeta?: (key: string, opts: TransactionOptions) => MaybePromise<StorageMeta | null>;
49
- getKeys: (base: string, opts: GetKeysOptions) => MaybePromise<string[]>;
50
- clear?: (base: string, opts: TransactionOptions) => MaybePromise<void>;
51
- dispose?: () => MaybePromise<void>;
52
- watch?: (callback: WatchCallback) => MaybePromise<Unwatch>;
53
- }
54
- type StorageDefinition = {
55
- items: unknown;
56
- [key: string]: unknown;
57
- };
58
- type StorageItemMap<T> = T extends StorageDefinition ? T["items"] : T;
59
- type StorageItemType<T, K> = K extends keyof StorageItemMap<T> ? StorageItemMap<T>[K] : T extends StorageDefinition ? StorageValue : T;
60
- interface Storage$1<T extends StorageValue = StorageValue> {
61
- hasItem<U extends Extract<T, StorageDefinition>, K extends keyof StorageItemMap<U>>(key: K, opts?: TransactionOptions): Promise<boolean>;
62
- hasItem(key: string, opts?: TransactionOptions): Promise<boolean>;
63
- getItem<U extends Extract<T, StorageDefinition>, K extends string & keyof StorageItemMap<U>>(key: K, ops?: TransactionOptions): Promise<StorageItemType<T, K> | null>;
64
- getItem<R = StorageItemType<T, string>>(key: string, opts?: TransactionOptions): Promise<R | null>;
65
- /** @experimental */
66
- getItems: <U extends T>(items: (string | {
67
- key: string;
68
- options?: TransactionOptions;
69
- })[], commonOptions?: TransactionOptions) => Promise<{
70
- key: string;
71
- value: U;
72
- }[]>;
73
- /** @experimental See https://github.com/unjs/unstorage/issues/142 */
74
- getItemRaw: <T = any>(key: string, opts?: TransactionOptions) => Promise<MaybeDefined<T> | null>;
75
- setItem<U extends Extract<T, StorageDefinition>, K extends keyof StorageItemMap<U>>(key: K, value: StorageItemType<T, K>, opts?: TransactionOptions): Promise<void>;
76
- setItem<U extends T>(key: string, value: U, opts?: TransactionOptions): Promise<void>;
77
- /** @experimental */
78
- setItems: <U extends T>(items: {
79
- key: string;
80
- value: U;
81
- options?: TransactionOptions;
82
- }[], commonOptions?: TransactionOptions) => Promise<void>;
83
- /** @experimental See https://github.com/unjs/unstorage/issues/142 */
84
- setItemRaw: <T = any>(key: string, value: MaybeDefined<T>, opts?: TransactionOptions) => Promise<void>;
85
- removeItem<U extends Extract<T, StorageDefinition>, K extends keyof StorageItemMap<U>>(key: K, opts?: (TransactionOptions & {
86
- removeMeta?: boolean;
87
- }) | boolean): Promise<void>;
88
- removeItem(key: string, opts?: (TransactionOptions & {
89
- removeMeta?: boolean;
90
- }) | boolean): Promise<void>;
91
- getMeta: (key: string, opts?: (TransactionOptions & {
92
- nativeOnly?: boolean;
93
- }) | boolean) => MaybePromise<StorageMeta>;
94
- setMeta: (key: string, value: StorageMeta, opts?: TransactionOptions) => Promise<void>;
95
- removeMeta: (key: string, opts?: TransactionOptions) => Promise<void>;
96
- getKeys: (base?: string, opts?: GetKeysOptions) => Promise<string[]>;
97
- clear: (base?: string, opts?: TransactionOptions) => Promise<void>;
98
- dispose: () => Promise<void>;
99
- watch: (callback: WatchCallback) => Promise<Unwatch>;
100
- unwatch: () => Promise<void>;
101
- mount: (base: string, driver: Driver) => Storage$1;
102
- unmount: (base: string, dispose?: boolean) => Promise<void>;
103
- getMount: (key?: string) => {
104
- base: string;
105
- driver: Driver;
106
- };
107
- getMounts: (base?: string, options?: {
108
- parents?: boolean;
109
- }) => {
110
- base: string;
111
- driver: Driver;
112
- }[];
113
- keys: Storage$1["getKeys"];
114
- get: Storage$1<T>["getItem"];
115
- set: Storage$1<T>["setItem"];
116
- has: Storage$1<T>["hasItem"];
117
- del: Storage$1<T>["removeItem"];
118
- remove: Storage$1<T>["removeItem"];
119
- }
120
- export { Storage$1 as Storage };