UNPKG

firesage

Version:

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

firesage.com

tylim88/firesage

14 lines (13 loc) • 979 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { WhereConstraint, DocumentId, __name__, MetaType, ErrorWhere__name__ } from '../types'; /** * Creates a {@link QueryConstraint} that enforces that documents must contain the * specified field and that the value should satisfy the relation constraint * provided. * * @param fieldPath - The path to compare * @param opStr - The operation string (e.g "&lt;", "&lt;=", "==", "&lt;", * "&lt;=", "!="). * @param value - The value for comparison * @returns The created {@link Query}. */ export declare const where: <T extends MetaType, FieldPath extends DocumentId | (keyof T["writeFlatten"] & string), OpStr extends import("@firebase/firestore").WhereFilterOp, Value>(fieldPath: FieldPath extends "__name__" ? "Error: Dont use ( __name__ ) directly as where's field path, use documentId() sentinel field path instead." : FieldPath, opStr: OpStr, value: Value) => WhereConstraint<T, FieldPath extends DocumentId ? "__name__" : FieldPath, OpStr, Value>;