@orbit/record-cache
Version:
Orbit base classes used to access and maintain a set of records.
27 lines (26 loc) • 1.93 kB
TypeScript
import { RequestOptions } from '@orbit/data';
import { RecordQuery, RecordQueryBuilder, RecordQueryResult, RecordSchema, RecordTransformBuilder } from '@orbit/records';
import { AsyncRecordCache } from '../async-record-cache';
import { RecordCacheQueryOptions, RecordCacheTransformOptions } from '../record-cache';
import { LiveQuery, LiveQuerySettings } from './live-query';
export interface AsyncLiveQueryUpdateSettings<QO extends RequestOptions = RecordCacheQueryOptions, TO extends RequestOptions = RecordCacheTransformOptions, QB = RecordQueryBuilder, TB = RecordTransformBuilder> {
cache: AsyncRecordCache<QO, TO, QB, TB>;
query: RecordQuery;
}
export declare class AsyncLiveQueryUpdate<QO extends RequestOptions = RecordCacheQueryOptions, TO extends RequestOptions = RecordCacheTransformOptions, QB = RecordQueryBuilder, TB = RecordTransformBuilder> {
private _cache;
private _query;
constructor(settings: AsyncLiveQueryUpdateSettings<QO, TO, QB, TB>);
query<Result extends RecordQueryResult = RecordQueryResult>(): Promise<Result>;
}
export interface AsyncLiveQuerySettings<QO extends RequestOptions = RecordCacheQueryOptions, TO extends RequestOptions = RecordCacheTransformOptions, QB = RecordQueryBuilder, TB = RecordTransformBuilder> extends LiveQuerySettings {
cache: AsyncRecordCache<QO, TO, QB, TB>;
}
export declare class AsyncLiveQuery<QO extends RequestOptions = RecordCacheQueryOptions, TO extends RequestOptions = RecordCacheTransformOptions, QB = RecordQueryBuilder, TB = RecordTransformBuilder> extends LiveQuery {
protected cache: AsyncRecordCache<QO, TO, QB, TB>;
protected get schema(): RecordSchema;
private get _update();
constructor(settings: AsyncLiveQuerySettings<QO, TO, QB, TB>);
query<Result extends RecordQueryResult = RecordQueryResult>(): Promise<Result>;
subscribe(cb: (update: AsyncLiveQueryUpdate<QO, TO, QB, TB>) => void): () => void;
}