shelving/db/QueryStore.d.ts

Toolkit for using data in JavaScript.

import { ArrayStore } from "../store/ArrayStore.js";
import { BooleanStore } from "../store/BooleanStore.js";
import type { Database, DataKey } from "../util/data.js";
import type { Identifier, Item } from "../util/item.js";
import type { ItemQuery } from "../util/query.js";
import type { StopCallback } from "../util/start.js";
import type { MemoryProvider } from "./MemoryProvider.js";
import type { AbstractProvider } from "./Provider.js";
/** Store a set of multiple items. */
export declare class QueryStore<I extends Identifier, T extends Database, K extends DataKey<T>> extends ArrayStore<Item<I, T[K]>> {
    readonly provider: AbstractProvider<I, T>;
    readonly collection: K;
    readonly query: ItemQuery<I, T[K]>;
    readonly busy: BooleanStore;
    readonly limit: number;
    /** Can more items be loaded after the current result. */
    get hasMore(): boolean;
    private _hasMore;
    /** Get the first item in this store. */
    get first(): Item<I, T[K]>;
    /** Get the last item in this store. */
    get last(): Item<I, T[K]>;
    constructor(collection: K, query: ItemQuery<I, T[K]>, provider: AbstractProvider<I, T>, memory?: MemoryProvider<I, T>);
    /** Refresh this store from the source provider. */
    refresh(provider?: AbstractProvider<I, T>): void;
    private _refresh;
    /** Refresh this store if data in the cache is older than `maxAge` (in milliseconds). */
    refreshStale(maxAge: number): void;
    /** Subscribe this store to a provider. */
    connect(provider?: AbstractProvider<I, T>): StopCallback;
    /**
     * Load more items after the last once.
     * - Promise that needs to be handled.
     */
    loadMore(): void;
    private _loadMore;
    [Symbol.iterator](): Iterator<Item<I, T[K]>>;
}