From 733461328d2151feda7aeb8296fda3fd8f31251c Mon Sep 17 00:00:00 2001 From: Cindy Peng <148148319+cindy-peng@users.noreply.github.com> Date: Tue, 29 Oct 2024 15:08:48 -0700 Subject: [PATCH 1/2] fix(doc): Fix param descriptions for filters --- src/filter.ts | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/src/filter.ts b/src/filter.ts index ca693549b..b16db4bda 100644 --- a/src/filter.ts +++ b/src/filter.ts @@ -34,18 +34,26 @@ enum CompositeOperator { } /** - * Returns an AND composite filter. + * And filters are composed of many other filters and when they are applied + * then query results are only returned when they pass through all these other + * filters. * - * @param {EntityFilter[]} filters The filters that make up the AND filter. + * @param {EntityFilter[]} filters The list of filters that make up the and filter. + * @returns {CompositeFilter} A composite AND filter. + * */ export function and(filters: EntityFilter[]): CompositeFilter { return new CompositeFilter(filters, CompositeOperator.AND); } /** - * Returns an OR composite filter. + * Or filters are composed of many other filters and when they are applied + * then query results are returned when they pass through any of these other + * filters. * - * @param {EntityFilter[]} filters The filters that make up the OR filter. + * @param {EntityFilter[]} filters The list of filters that make up the or filter. + * @returns {CompositeFilter} A composite OR filter. + * */ export function or(filters: EntityFilter[]): CompositeFilter { return new CompositeFilter(filters, CompositeOperator.OR); From 3362e5c9ecde8c9afee8102672eaa93ddb2fd607 Mon Sep 17 00:00:00 2001 From: Cindy Peng <148148319+cindy-peng@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:14:40 -0700 Subject: [PATCH 2/2] fix formatting --- src/filter.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/filter.ts b/src/filter.ts index b16db4bda..d062fb2e3 100644 --- a/src/filter.ts +++ b/src/filter.ts @@ -38,9 +38,9 @@ enum CompositeOperator { * then query results are only returned when they pass through all these other * filters. * - * @param {EntityFilter[]} filters The list of filters that make up the and filter. + * @param {EntityFilter[]} filters The list of filters that make up the AND filter. * @returns {CompositeFilter} A composite AND filter. - * + * */ export function and(filters: EntityFilter[]): CompositeFilter { return new CompositeFilter(filters, CompositeOperator.AND); @@ -51,9 +51,9 @@ export function and(filters: EntityFilter[]): CompositeFilter { * then query results are returned when they pass through any of these other * filters. * - * @param {EntityFilter[]} filters The list of filters that make up the or filter. + * @param {EntityFilter[]} filters The list of filters that make up the OR filter. * @returns {CompositeFilter} A composite OR filter. - * + * */ export function or(filters: EntityFilter[]): CompositeFilter { return new CompositeFilter(filters, CompositeOperator.OR);