shelving/db/ChangesProvider.d.ts

Toolkit for using data in JavaScript.

import type { MutableArray } from "../util/array.js";
import type { Database, DataKey } from "../util/data.js";
import type { Identifier } from "../util/item.js";
import type { ItemQuery } from "../util/query.js";
import type { Updates } from "../util/update.js";
import type { DatabaseChange, DatabaseChanges } from "./Change.js";
import { AsyncThroughProvider, ThroughProvider } from "./ThroughProvider.js";
/** Synchronous provider that keeps a log of any written changes to its `.changes` property. */
export declare class ChangesProvider<I extends Identifier, T extends Database> extends ThroughProvider<I, T> {
    get changes(): DatabaseChanges<I, T>;
    readonly _changes: MutableArray<DatabaseChange<I, T>>;
    addItem<K extends DataKey<T>>(collection: K, data: T[K]): I;
    setItem<K extends DataKey<T>>(collection: K, id: I, data: T[K]): void;
    updateItem<K extends DataKey<T>>(collection: K, id: I, updates: Updates<T[K]>): void;
    deleteItem<K extends DataKey<T>>(collection: K, id: I): void;
    setQuery<K extends DataKey<T>>(collection: K, query: ItemQuery<I, T[K]>, data: T[K]): void;
    updateQuery<K extends DataKey<T>>(collection: K, query: ItemQuery<I, T[K]>, updates: Updates<T[K]>): void;
    deleteQuery<K extends DataKey<T>>(collection: K, query: ItemQuery<I, T[K]>): void;
}
/** Asynchronous provider that keeps a log of any written changes to its `.written` property. */
export declare class AsyncLoggedProvider<I extends Identifier, T extends Database> extends AsyncThroughProvider<I, T> {
    get written(): DatabaseChanges<I, T>;
    readonly _written: MutableArray<DatabaseChange<I, T>>;
    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>;
    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>;
}