shelving/db/CacheProvider.d.ts

Toolkit for using data in JavaScript.

import type { Database, DataKey } from "../util/data.js";
import type { Identifier, Items, OptionalItem } from "../util/item.js";
import type { ItemQuery } from "../util/query.js";
import type { Sourceable } from "../util/source.js";
import type { Updates } from "../util/update.js";
import { MemoryProvider } from "./MemoryProvider.js";
import { AsyncProvider } from "./Provider.js";
/** Keep a copy of asynchronous remote data in a local synchronous cache. */
export declare class CacheProvider<I extends Identifier, T extends Database> extends AsyncProvider<I, T> implements Sourceable<AsyncProvider<I, T>> {
    readonly source: AsyncProvider<I, T>;
    readonly memory: MemoryProvider<I, T>;
    constructor(source: AsyncProvider<I, T>, cache?: MemoryProvider<I, T>);
    getItem<K extends DataKey<T>>(collection: K, id: I): Promise<OptionalItem<I, T[K]>>;
    getItemSequence<K extends DataKey<T>>(collection: K, id: I): AsyncIterable<OptionalItem<I, T[K]>>;
    addItem<K extends DataKey<T>>(collection: K, data: T[K]): Promise<I>;
    setItem<K extends DataKey<T>>(collection: K, id: I, data: T[K]): Promise<void>;
    updateItem<K extends DataKey<T>>(collection: K, id: I, updates: Updates<T[K]>): Promise<void>;
    deleteItem<K extends DataKey<T>>(collection: K, id: I): Promise<void>;
    countQuery<K extends DataKey<T>>(collection: K, query?: ItemQuery<I, T[K]>): Promise<number>;
    getQuery<K extends DataKey<T>>(collection: K, query?: ItemQuery<I, T[K]>): Promise<Items<I, T[K]>>;
    getQuerySequence<K extends DataKey<T>>(collection: K, query?: ItemQuery<I, T[K]>): AsyncIterable<Items<I, T[K]>>;
    setQuery<K extends DataKey<T>>(collection: K, query: ItemQuery<I, T[K]>, data: T[K]): Promise<void>;
    updateQuery<K extends DataKey<T>>(collection: K, query: ItemQuery<I, T[K]>, updates: Updates<T[K]>): Promise<void>;
    deleteQuery<K extends DataKey<T>>(collection: K, query: ItemQuery<I, T[K]>): Promise<void>;
}