@wix/wix-data-items-common 1.0.236 → 1.0.237

package/dist/types/api/WixDataSearch.d.ts

@@ -115,9 +115,9 @@ export interface WixDataSearch {
      */
     ascending(...fields: any): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value equals the specified value.
+     * Refines a search to match items where the value of the specified field equals the specified value.
      *
-     * The `eq()` method refines the search to only match items where the value of the specified field equals the specified `value`. It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.
+     * The `eq()` method refines the search to only match items where the value of the specified field equals the specified `value`. The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a number does not match the same number stored as a string.
      *
      * Matching strings with `eq()` is case-sensitive, so `"text"` is not considered equal to `"Text"`.
      *
@@ -133,11 +133,11 @@ export interface WixDataSearch {
      */
     eq(field: string, value: any): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value does not equal the specified value.
+     * Refines a search to match items where the value of the specified field does not equal the specified value.
      *
      * The `ne()` method refines the search to only match items where the value of the specified field does not equal the specified `value`.
      *
-     * It only matches values of the same type. For example, a number value stored as a String type is considered not equal to the same number stored as a Number type.
+     * The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a number is considered not equal to the same number stored as a string.
      *
      * Matching strings with `ne()` is case-sensitive, so `"text"` is not equal to `"Text"`.
      *
@@ -152,12 +152,12 @@ export interface WixDataSearch {
      */
     ne(field: string, value: any): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value is greater than or equal to the specified value.
+     * Refines a search to match items where the value of the specified field is greater than or equal to the specified value.
      *
      * The `ge()` method refines the search to only match items where the value of the specified field is greater than or equal to the specified `value`.
      *
-     * It only matches values of the same type. For example, a number value stored
-     * as a String type does not match the same number stored as a Number type.
+     * The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored
+     * as a number does not match the same number stored as a string.
      *
      * If a field contains a number as a String, that value is compared
      * alphabetically and not numerically. Items that do not have a value for the
@@ -178,11 +178,11 @@ export interface WixDataSearch {
      */
     ge(field: string, value: string | number | Date): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value is greater than the specified value.
+     * Refines a search to match items where the value of the specified field is greater than the specified value.
      *
      * The `gt()` method refines the search to only match items where the value of the specified field is greater than the specified `value`.
      *
-     * It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.
+     * The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a number does not match the same number stored as a string.
      *
      * If a field contains a number as a String, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
@@ -201,11 +201,11 @@ export interface WixDataSearch {
      */
     gt(field: string, value: string | number | Date): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value is less than or equal to the specified value.
+     * Refines a search to match items where the value of the specified field is less than or equal to the specified value.
      *
-     * The `le()` method refines the search to only match items where the value of the specified field is less than or equal to the specified `value`.
+     * The `le()` method refines the search to only match items where the value of the specified field is less than or equal to the specified value.
      *
-     * It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.
+     * The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a number does not match the same number stored as a string.
      *
      * If a field contains a number as a String, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
@@ -213,7 +213,7 @@ export interface WixDataSearch {
      * - Number: Compares numerically.
      * - Date: Compares JavaScript Date objects.
      * - String: Compares lexicographically, so `"ABC"` is less than or equal to `"abc"`, but `"abc"` is not less than or equal to `"ABC"`.
-     * - Reference: Compares by the ID of the referenced item as a String.
+     * - Reference: Compares by the ID of the referenced item as a string.
      * @public
      * @documentationMaturity preview
      * @param field - Field whose value is compared with `value`.
@@ -224,13 +224,13 @@ export interface WixDataSearch {
      */
     le(field: string, value: string | number | Date): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value is less than the specified value.
+     * Refines a search to match items where the value of the specified field is less than the specified value.
      *
      * The `lt()` method refines the search to only match items where the value of the specified field is less than the specified `value`.
      *
-     * It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.
+     * The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a number does not match the same number stored as a string.
      *
-     * If a field contains a number as a String, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
+     * If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
      * The following types of fields can be compared:
      * - Number: Compares numerically.
@@ -254,7 +254,7 @@ export interface WixDataSearch {
      * If the field contains any value at all for a given item, including an empty string or an invalid value, that item matches the search filter.
      * @public
      * @documentationMaturity preview
-     * @param field - Field in which to check for a non-empty value.
+     * @param field - Field to check for a non-empty value.
      * @requiredField field
      * @returns Refined WixDataSearch object.
      */
@@ -267,15 +267,15 @@ export interface WixDataSearch {
      * If the field contains any value at all for a given item, including an empty string or an invalid value, that item does not match the search filter.
      * @public
      * @documentationMaturity preview
-     * @param field - Field in which to check for an empty or non-existent value.
+     * @param field - Field to check for an empty or non-existent value.
      * @requiredField field
      * @returns Refined WixDataSearch object.
      */
     isEmpty(field: string): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value starts with a specified string.
+     * Refines a search to match items where the value of the specified field starts with a specified value.
      *
-     * The `startsWith()` method refines the search to only match items where the value of the specified field starts with the specified `string`. Matching with `startsWith()` is case-sensitive, so searching for `"Sun"` does not match an item that contains the text `"sunshine"`.
+     * The `startsWith()` method refines the search to only match items where the value of the specified field starts with the specified value. Matching with `startsWith()` is case-sensitive, so searching for `"Sun"` does not match an item that contains the text `"sunshine"`.
      *
      * You can only use `startsWith()` with a field whose value is a String or Reference. When using a Reference, `startsWith()` matches by the ID of the referenced item as a String.
      * @public
@@ -288,20 +288,20 @@ export interface WixDataSearch {
      */
     startsWith(field: string, value: string): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value equals any of the specified values.
+     * Refines a search to match items where the value of the specified field equals any of the specified values.
      *
      * The `hasSome()` method refines the search to only match items where the value of the specified field equals any of the specified values.
      *
-     * Matching strings with `hasSome()` is case-sensitive, so `"text"` is not equal to `"Text"`.
+     * Matching strings with `hasSome()` is case-sensitive, so `"text"` is not considered equal to `"Text"`.
      *
-     * If the specified field contains an array, `hasSome()` matches if any of the elements in that array match any of the specified values.
+     * If the specified field contains an array, `hasSome()` matches items where any of the array's elements match any of the specified values.
      *
-     * If the specified field contains multiple references, pass item IDs as the values. `hasSome()` matches if any of the multiple references match any of the specified ID values.
+     * If the specified field contains multiple references, pass item IDs as the values. `hasSome()` matches if any of the references match any of the specified ID values.
      *
-     * You can specify multiple values to match by providing an array of String, Number, or Date types as the `values` parameters.
+     * You can specify multiple values to match by providing an array of strings, numbers, or dates.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `values`.
+     * @param field - Field whose value is compared with the specified values.
      * @requiredField field
      * @param values - Values to match.
      * @requiredField values
@@ -309,18 +309,18 @@ export interface WixDataSearch {
      */
     hasSome(field: string, ...values: string[] | number[] | Date[]): WixDataSearch;
     /**
-     * Overload for `hasSome()`. Refines a search to match items whose specified field value equals any of the specified values.
+     * Overload for `hasSome()`. Refines a search to match items where the value of the specified field equals any of the specified values.
      * @public
      * @documentationMaturity preview
      * @param field - Field whose value is compared with the provided values.
      * @requiredField field
-     * @param values - An array of values to match.
+     * @param values - Array of values to match.
      * @requiredField values
      * @returns Refined WixDataSearch object.
      */
     hasSome(field: string, values: string[] | number[] | Date[]): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value equals all of the specified values.
+     * Refines a search to match items where the value of the specified field equals all of the specified values.
      *
      * The `hasAll()` method refines the search to only match items where the value of the specified field equals all of the specified values.
      *
@@ -339,7 +339,7 @@ export interface WixDataSearch {
      */
     hasAll(field: string, ...values: string[] | number[] | Date[]): WixDataSearch;
     /**
-     * Overload for `hasAll()`. Refines a search to match items whose specified field values equals all of the specified values.
+     * Overload for `hasAll()`. Refines a search to match items where the value of the specified fields equals all of the specified values.
      * @public
      * @documentationMaturity preview
      * @param field - Field whose value is compared with the provided values.
@@ -422,13 +422,13 @@ export interface WixDataSearch {
      */
     not(filter: WixDataFilter): WixDataSearch;
     /**
-     * Refines a search to match items whose specified field value is within a specified range.
+     * Refines a search to match items where the value of the specified field is within a specified range.
      *
      * The `between()` method refines the search to only match items where the value of the specified field is greater than or equal to `rangeStart` and less than `rangeEnd`.
      *
-     * It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.
+     * The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a number does not match the same number stored as a string.
      *
-     * If a field contains a number as a String, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
+     * If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
      * The following types of fields can be compared:
      * - Number: Compares numerically.

package/dist/types/api/expressions/expressions.d.ts

@@ -44,7 +44,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expressions - Expressions to add together. All expressions must resolve to numbers.
+     * @param expressions - Expressions to add together. All expressions must resolve to numbers. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns AddExpression object.
      */
     add(...expressions: Expression[]): AddExpression;
@@ -67,7 +67,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expressions - Expressions to multiply. All expressions must resolve to numbers.
+     * @param expressions - Expressions to multiply. All expressions must resolve to numbers. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns MultiplyExpression object.
      */
     multiply(...expressions: Expression[]): MultiplyExpression;
@@ -90,7 +90,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expressions - Expressions to calculate the total sum of. All expressions must resolve to numbers.
+     * @param expressions - Expressions to calculate the total sum of. All expressions must resolve to numbers. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns SumExpression object.
      */
     sum(...expressions: Expression[]): SumExpression;
@@ -101,7 +101,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to find the absolute value of. Expression must resolve to a number.
+     * @param expression - Expression to find the absolute value of. Expression must resolve to a number. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns AbsExpression object.
      */
     abs(expression: Expression): AbsExpression;
@@ -124,7 +124,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to round down to the nearest whole number. Expression must resolve to a number.
+     * @param expression - Expression to round down to the nearest whole number. Expression must resolve to a number. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns FloorExpression object.
      */
     floor(expression: Expression): FloorExpression;
@@ -135,18 +135,18 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to round up to the nearest whole number. Expression must resolve to a number.
+     * @param expression - Expression to round up to the nearest whole number. Expression must resolve to a number. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns CeilExpression object.
      */
     ceil(expression: Expression): CeilExpression;
     /**
-     * Joins multiple expressions together to create a string
+     * Joins multiple expressions together to create a string.
      *
      * The `concat()` method configures the aggregation pipeline to join multiple expressions together to create a new string.
      *
      * @public
      * @documentationMaturity preview
-     * @param expressions - Expressions to join together. All expressions must resolve to strings.
+     * @param expressions - Expressions to join together. All expressions must resolve to strings. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns ConcatExpression object.
      */
     concat(...expressions: Expression[]): ConcatExpression;
@@ -157,7 +157,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to convert to a string.
+     * @param expression - Expression to convert to a string. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns StringifyExpression object.
      */
     stringify(expression: Expression): StringifyExpression;
@@ -168,7 +168,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to convert to lowercase. Expression must resolve to a string.
+     * @param expression - Expression to convert to lowercase. Expression must resolve to a string. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns ToLowerExpression object.
      */
     toLower(expression: Expression): ToLowerExpression;
@@ -179,7 +179,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to convert to uppercase. Expression must resolve to a string.
+     * @param expression - Expression to convert to uppercase. Expression must resolve to a string. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns ToUpperExpression object.
      */
     toUpper(expression: Expression): ToUpperExpression;
@@ -190,7 +190,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to extract a substring from. Expression must resolve to a string.
+     * @param expression - Expression to extract a substring from. Expression must resolve to a string. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @param start - Starting position of the substring to extract, specified in zero-based indexing. Expression must resolve to a number.
      * @param length - Number of characters to extract from the starting position. Expression must resolve to a number.
      * @returns SubstringExpression object.
@@ -203,7 +203,7 @@ export interface WixDataAggregatePipelineExpressions {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to find the total number of characters of. Expression must resolve to a string.
+     * @param expression - Expression to find the total number of characters of. Expression must resolve to a string. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @returns LengthExpression object.
      */
     length(expression: Expression): LengthExpression;