@tanstack/db
Version:
A reactive client store for building super fast apps on sync
37 lines (36 loc) • 1.64 kB
text/typescript
import { Collection } from './collection/index.js';
import { CollectionStatus } from './types.js';
/**
* Shared helpers for the first-party framework adapters (`@tanstack/react-db`,
* `@tanstack/vue-db`, `@tanstack/svelte-db`, `@tanstack/solid-db`,
* `@tanstack/angular-db`).
*
* These centralize small pieces of logic every adapter used to duplicate, so
* they stay consistent across frameworks. They are intended for the official
* adapters; treat them as unstable for external use.
*/
/**
* Structural check for a live-query/`Collection` instance.
*
* Uses duck typing rather than `instanceof CollectionImpl` on purpose: adapters
* and core can resolve to different copies of `@tanstack/db` (dual-package /
* multi-realm), where `instanceof` gives false negatives. The three methods
* below uniquely identify a Collection.
*/
export declare function isCollection(value: unknown): value is Collection<any, any, any>;
/** Whether a collection yields a single result (`findOne`) rather than an array. */
export declare function isSingleResultCollection(collection: Collection<any, any, any>): boolean;
/** The derived boolean status flags every adapter exposes for a query. */
export interface LiveQueryStatusFlags {
isLoading: boolean;
isReady: boolean;
isIdle: boolean;
isError: boolean;
isCleanedUp: boolean;
}
/**
* Derive the boolean status flags from a collection status. Adapters represent
* a disabled query separately (with `isReady: true`); this covers the real
* `CollectionStatus` values.
*/
export declare function getLiveQueryStatusFlags(status: CollectionStatus): LiveQueryStatusFlags;