Skip to content

Commit bbb22b3

Browse files
committed
Updated documentation of or() and and() to match the latest API docs in the Android implementation.
1 parent 318d83f commit bbb22b3

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

packages/firestore/src/lite-api/query.ts

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -364,13 +364,14 @@ export type QueryFilterConstraint =
364364
| QueryCompositeFilterConstraint;
365365

366366
/**
367-
* Creates a {@link QueryCompositeFilterConstraint} that performs a logical OR
368-
* of all the provided {@link QueryFilterConstraint}s.
367+
* Creates a new {@link QueryCompositeFilterConstraint} that is a disjunction of
368+
* the given filter constraints. A disjunction filter includes a document if it
369+
* satisfies any of the given filters.
369370
*
370-
* @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
371-
* for OR operation. These must be created with calls to {@link where},
372-
* {@link or}, or {@link and}.
373-
* @returns The created {@link QueryCompositeFilterConstraint}.
371+
* @param queryConstraints - Optional. The list of
372+
* {@link QueryFilterConstraint}s to perform a disjunction for. These must be
373+
* created with calls to {@link where}, {@link or}, or {@link and}.
374+
* @returns The newly created {@link QueryCompositeFilterConstraint}.
374375
* @internal TODO remove this internal tag with OR Query support in the server
375376
*/
376377
export function or(
@@ -388,13 +389,14 @@ export function or(
388389
}
389390

390391
/**
391-
* Creates a {@link QueryCompositeFilterConstraint} that performs a logical AND
392-
* of all the provided {@link QueryFilterConstraint}s.
392+
* Creates a new {@link QueryCompositeFilterConstraint} that is a conjunction of
393+
* the given filter constraints. A conjunction filter includes a document if it
394+
* satisfies all of the given filters.
393395
*
394-
* @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
395-
* for AND operation. These must be created with calls to {@link where},
396-
* {@link or}, or {@link and}.
397-
* @returns The created {@link QueryCompositeFilterConstraint}.
396+
* @param queryConstraints - Optional. The list of
397+
* {@link QueryFilterConstraint}s to perform a conjunction for. These must be
398+
* created with calls to {@link where}, {@link or}, or {@link and}.
399+
* @returns The newly created {@link QueryCompositeFilterConstraint}.
398400
* @internal TODO remove this internal tag with OR Query support in the server
399401
*/
400402
export function and(

0 commit comments

Comments
 (0)