full site update
This commit is contained in:
121
node_modules/unstorage/dist/shared/unstorage.Ca7R4QL2.d.cts
generated
vendored
Normal file
121
node_modules/unstorage/dist/shared/unstorage.Ca7R4QL2.d.cts
generated
vendored
Normal file
@@ -0,0 +1,121 @@
|
||||
type StorageValue = null | string | number | boolean | object;
|
||||
type WatchEvent = "update" | "remove";
|
||||
type WatchCallback = (event: WatchEvent, key: string) => any;
|
||||
type MaybePromise<T> = T | Promise<T>;
|
||||
type MaybeDefined<T> = T extends any ? T : any;
|
||||
type Unwatch = () => MaybePromise<void>;
|
||||
interface StorageMeta {
|
||||
atime?: Date;
|
||||
mtime?: Date;
|
||||
ttl?: number;
|
||||
[key: string]: StorageValue | Date | undefined;
|
||||
}
|
||||
type TransactionOptions = Record<string, any>;
|
||||
type GetKeysOptions = TransactionOptions & {
|
||||
maxDepth?: number;
|
||||
};
|
||||
interface DriverFlags {
|
||||
maxDepth?: boolean;
|
||||
ttl?: boolean;
|
||||
}
|
||||
interface Driver<OptionsT = any, InstanceT = any> {
|
||||
name?: string;
|
||||
flags?: DriverFlags;
|
||||
options?: OptionsT;
|
||||
getInstance?: () => InstanceT;
|
||||
hasItem: (key: string, opts: TransactionOptions) => MaybePromise<boolean>;
|
||||
getItem: (key: string, opts?: TransactionOptions) => MaybePromise<StorageValue>;
|
||||
/** @experimental */
|
||||
getItems?: (items: {
|
||||
key: string;
|
||||
options?: TransactionOptions;
|
||||
}[], commonOptions?: TransactionOptions) => MaybePromise<{
|
||||
key: string;
|
||||
value: StorageValue;
|
||||
}[]>;
|
||||
/** @experimental */
|
||||
getItemRaw?: (key: string, opts: TransactionOptions) => MaybePromise<unknown>;
|
||||
setItem?: (key: string, value: string, opts: TransactionOptions) => MaybePromise<void>;
|
||||
/** @experimental */
|
||||
setItems?: (items: {
|
||||
key: string;
|
||||
value: string;
|
||||
options?: TransactionOptions;
|
||||
}[], commonOptions?: TransactionOptions) => MaybePromise<void>;
|
||||
/** @experimental */
|
||||
setItemRaw?: (key: string, value: any, opts: TransactionOptions) => MaybePromise<void>;
|
||||
removeItem?: (key: string, opts: TransactionOptions) => MaybePromise<void>;
|
||||
getMeta?: (key: string, opts: TransactionOptions) => MaybePromise<StorageMeta | null>;
|
||||
getKeys: (base: string, opts: GetKeysOptions) => MaybePromise<string[]>;
|
||||
clear?: (base: string, opts: TransactionOptions) => MaybePromise<void>;
|
||||
dispose?: () => MaybePromise<void>;
|
||||
watch?: (callback: WatchCallback) => MaybePromise<Unwatch>;
|
||||
}
|
||||
type StorageDefinition = {
|
||||
items: unknown;
|
||||
[key: string]: unknown;
|
||||
};
|
||||
type StorageItemMap<T> = T extends StorageDefinition ? T["items"] : T;
|
||||
type StorageItemType<T, K> = K extends keyof StorageItemMap<T> ? StorageItemMap<T>[K] : T extends StorageDefinition ? StorageValue : T;
|
||||
interface Storage<T extends StorageValue = StorageValue> {
|
||||
hasItem<U extends Extract<T, StorageDefinition>, K extends keyof StorageItemMap<U>>(key: K, opts?: TransactionOptions): Promise<boolean>;
|
||||
hasItem(key: string, opts?: TransactionOptions): Promise<boolean>;
|
||||
getItem<U extends Extract<T, StorageDefinition>, K extends string & keyof StorageItemMap<U>>(key: K, ops?: TransactionOptions): Promise<StorageItemType<T, K> | null>;
|
||||
getItem<R = StorageItemType<T, string>>(key: string, opts?: TransactionOptions): Promise<R | null>;
|
||||
/** @experimental */
|
||||
getItems: <U extends T>(items: (string | {
|
||||
key: string;
|
||||
options?: TransactionOptions;
|
||||
})[], commonOptions?: TransactionOptions) => Promise<{
|
||||
key: string;
|
||||
value: U;
|
||||
}[]>;
|
||||
/** @experimental See https://github.com/unjs/unstorage/issues/142 */
|
||||
getItemRaw: <T = any>(key: string, opts?: TransactionOptions) => Promise<MaybeDefined<T> | null>;
|
||||
setItem<U extends Extract<T, StorageDefinition>, K extends keyof StorageItemMap<U>>(key: K, value: StorageItemType<T, K>, opts?: TransactionOptions): Promise<void>;
|
||||
setItem<U extends T>(key: string, value: U, opts?: TransactionOptions): Promise<void>;
|
||||
/** @experimental */
|
||||
setItems: <U extends T>(items: {
|
||||
key: string;
|
||||
value: U;
|
||||
options?: TransactionOptions;
|
||||
}[], commonOptions?: TransactionOptions) => Promise<void>;
|
||||
/** @experimental See https://github.com/unjs/unstorage/issues/142 */
|
||||
setItemRaw: <T = any>(key: string, value: MaybeDefined<T>, opts?: TransactionOptions) => Promise<void>;
|
||||
removeItem<U extends Extract<T, StorageDefinition>, K extends keyof StorageItemMap<U>>(key: K, opts?: (TransactionOptions & {
|
||||
removeMeta?: boolean;
|
||||
}) | boolean): Promise<void>;
|
||||
removeItem(key: string, opts?: (TransactionOptions & {
|
||||
removeMeta?: boolean;
|
||||
}) | boolean): Promise<void>;
|
||||
getMeta: (key: string, opts?: (TransactionOptions & {
|
||||
nativeOnly?: boolean;
|
||||
}) | boolean) => MaybePromise<StorageMeta>;
|
||||
setMeta: (key: string, value: StorageMeta, opts?: TransactionOptions) => Promise<void>;
|
||||
removeMeta: (key: string, opts?: TransactionOptions) => Promise<void>;
|
||||
getKeys: (base?: string, opts?: GetKeysOptions) => Promise<string[]>;
|
||||
clear: (base?: string, opts?: TransactionOptions) => Promise<void>;
|
||||
dispose: () => Promise<void>;
|
||||
watch: (callback: WatchCallback) => Promise<Unwatch>;
|
||||
unwatch: () => Promise<void>;
|
||||
mount: (base: string, driver: Driver) => Storage;
|
||||
unmount: (base: string, dispose?: boolean) => Promise<void>;
|
||||
getMount: (key?: string) => {
|
||||
base: string;
|
||||
driver: Driver;
|
||||
};
|
||||
getMounts: (base?: string, options?: {
|
||||
parents?: boolean;
|
||||
}) => {
|
||||
base: string;
|
||||
driver: Driver;
|
||||
}[];
|
||||
keys: Storage["getKeys"];
|
||||
get: Storage<T>["getItem"];
|
||||
set: Storage<T>["setItem"];
|
||||
has: Storage<T>["hasItem"];
|
||||
del: Storage<T>["removeItem"];
|
||||
remove: Storage<T>["removeItem"];
|
||||
}
|
||||
|
||||
export type { Driver as D, GetKeysOptions as G, StorageValue as S, TransactionOptions as T, Unwatch as U, WatchEvent as W, Storage as a, WatchCallback as b, StorageMeta as c, DriverFlags as d };
|
Reference in New Issue
Block a user