Skip to content

Commit a18c169

Browse files
cindy-pengkevkim-codesdanieljbruce
authored
fix(doc): Fix param descriptions for filters (#1346)
* fix(doc): Fix param descriptions for filters * fix formatting --------- Co-authored-by: Kevin Kim <[email protected]> Co-authored-by: danieljbruce <[email protected]>
1 parent d1d399a commit a18c169

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

src/filter.ts

+12-4
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,26 @@ enum CompositeOperator {
3434
}
3535

3636
/**
37-
* Returns an AND composite filter.
37+
* And filters are composed of many other filters and when they are applied
38+
* then query results are only returned when they pass through all these other
39+
* filters.
40+
*
41+
* @param {EntityFilter[]} filters The list of filters that make up the AND filter.
42+
* @returns {CompositeFilter} A composite AND filter.
3843
*
39-
* @param {EntityFilter[]} filters The filters that make up the AND filter.
4044
*/
4145
export function and(filters: EntityFilter[]): CompositeFilter {
4246
return new CompositeFilter(filters, CompositeOperator.AND);
4347
}
4448

4549
/**
46-
* Returns an OR composite filter.
50+
* Or filters are composed of many other filters and when they are applied
51+
* then query results are returned when they pass through any of these other
52+
* filters.
53+
*
54+
* @param {EntityFilter[]} filters The list of filters that make up the OR filter.
55+
* @returns {CompositeFilter} A composite OR filter.
4756
*
48-
* @param {EntityFilter[]} filters The filters that make up the OR filter.
4957
*/
5058
export function or(filters: EntityFilter[]): CompositeFilter {
5159
return new CompositeFilter(filters, CompositeOperator.OR);

0 commit comments

Comments
 (0)