firelordjs/dist/types/queryConstraints/cursor.d.ts

🔥 High Precision Typescript Wrapper for Firestore Web, Providing Unparalleled Type Safe and Dev Experience

import { MetaType } from '../metaTypeCreator';
import { ErrorMoreThanOnceDocSnapshotInCursor, ErrorEmptyCursor, ErrorCursorNoArray } from '../error';
import { DocumentSnapshot, QueryDocumentSnapshot } from '../snapshot';
import { OriQueryConstraint } from '../alias';
export type CursorType = 'startAt' | 'startAfter' | 'endAt' | 'endBefore';
export type CursorConstraint<Type extends CursorType, Values extends unknown[]> = {
    type: Type;
    values: Values;
    ref: QueryConstraint<Type>;
};
export interface QueryConstraint<T extends CursorType> extends OriQueryConstraint {
    type: T;
}
export type Cursor<Type extends CursorType> = <const Values extends unknown[]>(...snapshotOrFieldValues: Values['length'] extends 0 ? [ErrorEmptyCursor] : number extends Values['length'] ? [ErrorCursorNoArray] : Values extends (infer R)[] ? DocumentSnapshot<MetaType> extends R ? Values['length'] extends 1 ? Values : ErrorMoreThanOnceDocSnapshotInCursor[] : QueryDocumentSnapshot<MetaType> extends R ? Values['length'] extends 1 ? Values : ErrorMoreThanOnceDocSnapshotInCursor[] : Values : Values) => CursorConstraint<Type, Values>;