QueryInstance
Any query, whatever its collection and result
Import
import { QueryInstance } from "@hyper-fetch/db"
Source
Package
Preview
class Query<Row, Loaders, Result, Tokens, Eq, Order, Mode, Local> {
constructor(runtime: DbRuntime, definition: QueryDefinition) {};
key: string;
definition: QueryDefinition;
__types: { eq: Eq; loaders: Loaders; local: Local; mode: Mode; order: Order; result: Result; row: Row; tokens: Tokens };
explain() => QueryExplanation;
fetchNextPage() => Promise<void>;
get(this: Query<Row, Loaders, Result, Tokens, Eq, Order, Mode, Local> & ServableCheck<Loaders, Tokens, Eq, Order, Mode, Local>) => Promise<QueryState<QueryData<Result, Mode>>>;
getSnapshot() => QueryState<QueryData<Result, Mode>>;
infinite(this: Query<Row, Loaders, Result, Tokens, Eq, Order, Mode, Local> & ServableCheck<Loaders, Tokens, Eq, Order, Mode, Local> & InfiniteCheck<Order, Mode>, options: InfiniteQueryOptions) => InfiniteQuery<Result>;
join<Name, Target, Field, On, Type>(name: Name, collection: Target, by: JoinSpec<Row, Field, JoinedMatchOf<Target, On>, On, Type>) => Query<Row, Loaders, Joined<Result, Name, JoinedValue<JoinedRowOf<Target>, On, Type>>, Tokens, Eq, Order, Mode, Local>;
limit(this: Query<Row, Loaders, Result, Tokens, Eq, Order, list, Local>, limit: number) => Query<Row, Loaders, Result, Tokens, Eq, Order, Mode, Local>;
local() => Query<Row, Loaders, Result, Tokens, Eq, Order, Mode, true>;
orderBy<Name>(this: Query<Row, Loaders, Result, Tokens, Eq, Order, list, Local>, callback: (row: RowRefs<Row>) => FieldRef<Name, Row[Name]>, direction: SortDirection) => Query<Row, Loaders, Result, Tokens, Eq, Order | Name, Mode, Local>;
refetch() => Promise<void>;
select<Selection>(callback: (row: RowRefs<Row>) => Selection) => Query<Row, Loaders, Selected<Selection>, Tokens, Eq, Order, Mode, Local>;
subscribe(this: Query<Row, Loaders, Result, Tokens, Eq, Order, Mode, Local> & ServableCheck<Loaders, Tokens, Eq, Order, Mode, Local>, listener: () => void) => () => void;
where<C>(this: Query<Row, Loaders, Result, Tokens, Eq, Order, list, Local>, callback: (row: RowRefs<Row>) => C) => Query<Row, Loaders, Result, Tokens | ExtractConditionTokens<C>, Eq | ExtractConditionEq<C>, Order, Mode, Local>;
}
