From 642070fce98c51394dff421bf9f09eaddefade3a Mon Sep 17 00:00:00 2001 From: idanlib-wix Date: Mon, 29 Jul 2024 11:46:52 +0300 Subject: [PATCH] DocWorks for wix-data - 17 changes detected, but 8 issue detected changes: Service wix-data has changed description Service wix-data operation bulkSave has changed description Service wix-data operation bulkUpdate has changed description Service wix-data operation get has changed description Service wix-data operation insert has changed param collectionId doc Service wix-data operation insert has changed description Service wix-data operation insertReference has changed description Service wix-data operation query has changed description Service wix-data operation queryReferenced has changed description Service wix-data operation save has changed description Service wix-data operation update has changed description Service wix-data message WixDataOptions member consistentRead has changed doc Service wix-data message WixDataQueryOptions member consistentRead has changed doc Service wix-data message WixDataQueryOptions member omitTotalCount has changed doc Service wix-data message WixDataQueryReferencedOptions member order has changed doc Service wix-data message WixDataQueryReferencedOptions member consistentRead has changed doc Service wix-data message WixDataQueryReferencedOptions member omitTotalCount has changed doc issues: Operation eq has an unknown param type * (filterMixin.js (33)) Operation ne has an unknown param type * (filterMixin.js (59)) Operation hasSome has an unknown param type * (filterMixin.js (342)) Operation hasAll has an unknown param type * (filterMixin.js (378)) Operation onFailure has an unknown param type Error (hooks.js (490)) Operation truncate has an unknown return type null (data-api.js (433)) Message WixDataBulkRemoveResult has an unknown property type Error (data-api.js (467)) Message WixDataBulkResult has an unknown property type Error (data-api.js (858)) --- wix-data/wix-data.service.json | 140 ++++++++++++++++++--------------- 1 file changed, 75 insertions(+), 65 deletions(-) diff --git a/wix-data/wix-data.service.json b/wix-data/wix-data.service.json index c28700c6db..2eda0679a7 100644 --- a/wix-data/wix-data.service.json +++ b/wix-data/wix-data.service.json @@ -37,7 +37,8 @@ " + When using data retrieval methods such as `query()` or `get()` following a change to your database collection, the data retrieved may not yet contain ", " your most recent changes. See [Wix-data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.", " + When querying [Wix App Collections](https://support.wix.com/en/article/content-manager-working-with-wix-app-collections), check which fields can be filtered in the relevant [collection field article](https://support.wix.com/en/search?term=velo%20collection%20fields).", - " + [Updating](wix-data/update) a collection item replaces the existing database item. If the existing item had properties with values and those properties are not included in the updated item, ", + " + When your site makes a data request, it may take some time to receive a response. Wix Data places limits on how long a response can take before the [request times out](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/working-with-wix-data#request-timeouts). If the response time exceeds this limit, Wix Data returns an error instead of the intended result. ", + " + [Updating](https://dev.wix.com/docs/velo/api-reference/wix-data/update) a collection item replaces the existing database item. If the existing item had properties with values and those properties are not included in the updated item, ", " the values in those properties are lost.", " + Aggregations can only be used on collections you created. They cannot be used on [Wix App Collections](https://support.wix.com/en/article/content-manager-working-with-wix-app-collections).", " + Some functions don't apply to [Single Item Collections](https://support.wix.com/en/article/content-manager-about-collections-with-a-single-item).", @@ -135,7 +136,7 @@ { "type": "wix-data.WixDataAggregate", "doc": "An aggregate object." }, "locations": - [ { "lineno": 1055, + [ { "lineno": 1056, "filename": "data-api.js" } ], "docs": { "summary": "Creates an aggregation.", @@ -236,7 +237,7 @@ [ "wix-data.WixDataBulkResult" ] }, "doc": "Fulfilled - The results of the bulk insert.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 869, + [ { "lineno": 870, "filename": "data-api.js" } ], "docs": { "summary": "Adds a number of items to a collection.", @@ -505,7 +506,7 @@ [ "wix-data.WixDataBulkRemoveResult" ] }, "doc": "Fulfilled - The results of the bulk remove.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 476, + [ { "lineno": 477, "filename": "data-api.js" } ], "docs": { "summary": "Removes a number of items from a collection.", @@ -596,7 +597,8 @@ "extra": { } }, { "name": "bulkSave", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -619,7 +621,7 @@ [ "wix-data.WixDataBulkResult" ] }, "doc": "Fulfilled - The results of the bulk save.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 932, + [ { "lineno": 933, "filename": "data-api.js" } ], "docs": { "summary": "Inserts or updates a number of items in a collection.", @@ -652,14 +654,14 @@ " When saving items to a collection that has a reference field, set", " the values of the reference fields to the referenced item's `_id` value or", " the entire referenced item object.", - " ", + "", " The maximum size of an item that you can save to a collection is 500kb.", "", - "> **Notes:** ", + "> **Notes:**", "> - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.", "> - Bulk operations are limited to 1000 items per function call.", "> - The `bulkSave()` function is not supported for Single Item Collections.", - "> - The `bulkSave()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference). ", + "> - The `bulkSave()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).", "> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkSave()` will fail and issue an error." ], "links": [], "examples": @@ -864,7 +866,8 @@ "extra": { } }, { "name": "bulkUpdate", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -887,7 +890,7 @@ [ "wix-data.WixDataBulkResult" ] }, "doc": "Fulfilled - The results of the bulk save.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 993, + [ { "lineno": 994, "filename": "data-api.js" } ], "docs": { "summary": "Updates a number of items in a collection.", @@ -906,9 +909,9 @@ " The `bulkUpdate()` function compares the `_id` property of the specified", " items with the `_id` property values of the items in the specified", " collection.", - " ", + "", " > **Warning:** If an existing item in the specified collection matches the `_id` of the specified item, `bulkUpdate`", - " replaces the existing item's property values with the ones in the specified item. ", + " replaces the existing item's property values with the ones in the specified item.", " **If the existing item had properties with values and those properties were not", " included in the specified item, the values in those properties are lost.**", " The item's `_updatedDate` property is also updated to the current date.", @@ -926,10 +929,10 @@ " the entire referenced item object.", "", "The maximum size of an item that you can update in a collection is 500kb.", - "> **Notes:** ", + "> **Notes:**", "> - Bulk operations are limited to 1000 items per function call.", "> - The `bulkUpdate()` function is not supported for Single Item Collections.", - "> - The `bulkUpdate()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference). ", + "> - The `bulkUpdate()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).", "> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkUpdate()` will fail and issue an error." ], "links": [], "examples": @@ -1090,7 +1093,7 @@ { "type": "wix-data.WixDataFilter", "doc": "A filter object." }, "locations": - [ { "lineno": 364, + [ { "lineno": 365, "filename": "data-api.js" } ], "docs": { "summary": "Creates a filter to be used with datasets and aggregations.", @@ -1118,7 +1121,8 @@ "extra": { } }, { "name": "get", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -1138,7 +1142,7 @@ [ "Object" ] }, "doc": "Fulfilled - The retrieved item or null if not found.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 196, + [ { "lineno": 197, "filename": "data-api.js" } ], "docs": { "summary": "Retrieves an item from a collection.", @@ -1146,9 +1150,9 @@ [ "The `get()` function returns a Promise that resolves to the item with ID", " `itemId` from the specified collection, or null if the `itemId` is not found. The Promise is rejected if the", " current user does not have read permissions for the collection.", - " ", + "", " If the specified collection contains reference fields, the ID of the referenced item is returned. To return the values of the referenced items use [`query()`](wix-data/query) and [`include()`](wix-data/wixdataquery/include).", - " ", + "", " If the `get()` function is passed the ID of a hidden item, it returns `null`.", "", " Calling the `get()` function triggers the [`beforeGet()`](wix-data.Hooks.html#beforeGet)", @@ -1157,7 +1161,7 @@ " Use the `options` parameter to run `get()` from backend code without", " checking for permissions or without its registered hooks.", "", - " > **Notes:** ", + " > **Notes:**", " > - When using the `query()` or `get()` functions or another data retrieval method following a change to your database collection, the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](wix-data.html#wix-data-and-eventual-consistency) for more information. To solve this problem, you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay retrieving data following any changes to your database collection.", " > - An `itemId` is required to retrieve an item even from a single-item collection." ], "links": [], @@ -1228,12 +1232,13 @@ "extra": { } }, { "name": "insert", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", "type": "string", - "doc": "The ID of the collection to add the item to. \n\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\nHover over your collection, click the three dots, and select **Edit Settings**." }, + "doc": "The ID of the collection to add the item to.\n\nTo find your `collectionId`, select the **Databases** tab in the [Velo Sidebar](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar).\nHover over your collection, click the three dots, and select **Edit Settings**." }, { "name": "item", "type": "Object", "doc": "The item to add." }, @@ -1248,7 +1253,7 @@ [ "Object" ] }, "doc": "Fulfilled - The item that was added.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 233, + [ { "lineno": 234, "filename": "data-api.js" } ], "docs": { "summary": "Adds an item to a collection.", @@ -1285,11 +1290,11 @@ "", "The maximum size of an item that you can add to a collection is 500kb.", "", - "> **Notes:** ", + "> **Notes:**", "> - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.", - "> - When creating a Single Item Collection, an item with the system field `_id` is pre-inserted into the collection. Single Item Collections may contain only one item. ", - "> - If there is a pre-existing item in a Single Item Collection, the `insert()` function will not run. To update or change an item in a Single Item Collection see the [`update()`](#update) and [`save()`](#save) functions. ", - "> - The `insert()` function does not support multi-reference fields. For multi-reference fields, use [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference). ", + "> - When creating a Single Item Collection, an item with the system field `_id` is pre-inserted into the collection. Single Item Collections may contain only one item.", + "> - If there is a pre-existing item in a Single Item Collection, the `insert()` function will not run. To update or change an item in a Single Item Collection see the [`update()`](#update) and [`save()`](#save) functions.", + "> - The `insert()` function does not support multi-reference fields. For multi-reference fields, use [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).", "> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `insert()` will fail and issue an error." ], "links": [], "examples": @@ -1500,7 +1505,8 @@ "extra": { } }, { "name": "insertReference", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -1536,7 +1542,7 @@ [ "void" ] }, "doc": "Fulfilled - When the references have been inserted.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 723, + [ { "lineno": 724, "filename": "data-api.js" } ], "docs": { "summary": "Inserts a reference in the specified property.", @@ -1548,7 +1554,7 @@ "", " Calling the `insertReference()` function does not trigger any hooks.", "", - "> **Notes:** ", + "> **Notes:**", "> - The `insertReference()` function only applies to multi-reference fields.", "> - The `insertReference()` function is not supported for Single Item Collections." ], "links": [], @@ -1620,7 +1626,7 @@ [ "boolean" ] }, "doc": "Fulfilled - Whether the referring item contains a reference to the referenced item or not.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 825, + [ { "lineno": 826, "filename": "data-api.js" } ], "docs": { "summary": "Checks if a reference to the referenced item exists in the specified\n property of the referring item.", @@ -1656,7 +1662,8 @@ "extra": { } }, { "name": "query", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -1666,7 +1673,7 @@ { "type": "wix-data.WixDataQuery", "doc": "A query object." }, "locations": - [ { "lineno": 295, + [ { "lineno": 296, "filename": "data-api.js" } ], "docs": { "summary": "Creates a query for retrieving items from a database collection.", @@ -1690,7 +1697,7 @@ " + [`descending`](wix-data.WixDataQuery.html#descending): by `_createdDate`", " + [`include`](wix-data.WixDataQuery.html#include): none", "", - " ", + "", "", " The functions that are chained to `query()` are applied in the order they", " are called. For example, if you sort on an `age` property in ascending", @@ -1712,9 +1719,9 @@ " + Read-only", "Check [which fields](https://support.wix.com/en/search?term=velo%20collection%20fields) can be used in a query.", "", - " > **Note:** ", - " When using the `query()` or `get()` functions or another data retrieval method following a change to your database collection, ", - "the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](wix-data.html#wix-data-and-eventual-consistency) for more information. To solve this problem, ", + " > **Note:**", + " When using the `query()` or `get()` functions or another data retrieval method following a change to your database collection,", + "the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](wix-data.html#wix-data-and-eventual-consistency) for more information. To solve this problem,", "you can use the [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Timeouts_and_intervals#setTimeout) function to delay retrieving data following any changes to your database collection." ], "links": [], "examples": @@ -1910,7 +1917,8 @@ "extra": { } }, { "name": "queryReferenced", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -1935,7 +1943,7 @@ [ "wix-data.WixDataQueryReferencedResult" ] }, "doc": "Fulfilled - The referenced items.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 673, + [ { "lineno": 674, "filename": "data-api.js" } ], "docs": { "summary": "Gets the full items referenced in the specified property.", @@ -1960,12 +1968,12 @@ " You can optionally control the order of the returned referenced items by", " passing a `WixDataQueryReferencedOptions` object.", "", - " > **Notes:** ", + " > **Notes:**", " > - Calling the `queryReferenced()` function does not trigger any hooks.", " > - You can only use the `queryReferenced()` function with [multiple-item reference fields](https://support.wix.com/en/article/about-referencing-multiple-items-in-one-field), and not with single-item (regular) reference fields.", " > - The `queryReferenced()` function is not supported for Single Item Collections.", - " ", - " For a discussion of when to use the similar [`include()`](wix-data.WixDataQuery.html#include) ", + "", + " For a discussion of when to use the similar [`include()`](wix-data.WixDataQuery.html#include)", " function and when to use `queryReferenced()`, see [Querying Items that Reference Other Items](https://support.wix.com/en/article/including-referenced-data-when-filtering)." ], "links": [], "examples": @@ -2061,7 +2069,7 @@ [ "Object" ] }, "doc": "Fulfilled - The removed item, or `null` if the item was not found.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 392, + [ { "lineno": 393, "filename": "data-api.js" } ], "docs": { "summary": "Removes an item from a collection.", @@ -2198,7 +2206,7 @@ [ "void" ] }, "doc": "Fulfilled - When the references have been removed.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 792, + [ { "lineno": 793, "filename": "data-api.js" } ], "docs": { "summary": "Removes a reference from the specified property.", @@ -2286,7 +2294,7 @@ [ "void" ] }, "doc": "Fulfilled - When the references have been inserted.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 758, + [ { "lineno": 759, "filename": "data-api.js" } ], "docs": { "summary": "Replaces current references with references in the specified property.", @@ -2338,7 +2346,8 @@ "extra": { } }, { "name": "save", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -2358,7 +2367,7 @@ [ "Object" ] }, "doc": "Fulfilled - The item that was either inserted or updated, depending on whether it previously existed in the collection.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 516, + [ { "lineno": 517, "filename": "data-api.js" } ], "docs": { "summary": "Inserts or updates an item in a collection.", @@ -2376,7 +2385,7 @@ " collection, triggering the [`beforeUpdate()`](wix-data.Hooks.html#beforeUpdate)", " and [`afterUpdate()`](wix-data.Hooks.html#afterUpdate) hooks if they have", " been defined. If none of the items in the collection contain that `_id` value, the", - " specified item does not have an `_id` property, or if the specified item's `id` property ", + " specified item does not have an `_id` property, or if the specified item's `id` property", " is `undefined`, `save()` uses [`insert()`](#insert) to add the specified item to the", " collection. This triggers the [`beforeInsert()`](wix-data.Hooks.html#beforeInsert)", " and [`afterInsert()`](wix-data.Hooks.html#afterInsert) hooks if they have", @@ -2393,7 +2402,7 @@ "", " > **Notes:**", " > - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.", - " > - The `save()` function does not support multi-reference fields. For multi-reference fields, use [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference) or [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) ", + " > - The `save()` function does not support multi-reference fields. For multi-reference fields, use [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference) or [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences)", " > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `save()` will fail and issue an error." ], "links": [], "examples": @@ -2594,7 +2603,7 @@ { "type": "wix-data.WixDataSort", "doc": "A sort object." }, "locations": - [ { "lineno": 378, + [ { "lineno": 379, "filename": "data-api.js" } ], "docs": { "summary": "Creates a sort to be used with the dataset `setSort()` function.", @@ -2639,7 +2648,7 @@ [ "null" ] }, "doc": "Fulfilled - When the items have been removed.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 432, + [ { "lineno": 433, "filename": "data-api.js" } ], "docs": { "summary": "Removes all items from a collection.", @@ -2700,7 +2709,8 @@ "extra": { } }, { "name": "update", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "collectionId", @@ -2720,7 +2730,7 @@ [ "Object" ] }, "doc": "Fulfilled - The object that was updated.\nRejected - The error that caused the rejection." }, "locations": - [ { "lineno": 572, + [ { "lineno": 573, "filename": "data-api.js" } ], "docs": { "summary": "Updates an item in a collection.", @@ -2755,9 +2765,9 @@ "", "The maximum size of an item that you can update in a collection is 500kb.", "", - " >**Notes:** ", + " >**Notes:**", " > - The specified item must include an `_id` property that already exists in the collection.", - " > - The `update()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference). ", + " > - The `update()` function does not support multi-reference fields. For multi-reference fields, use [`replaceReferences()`](https://www.wix.com/velo/reference/wix-data/replacereferences) or [`insertReference()`](https://www.wix.com/velo/reference/wix-data/insertreference).", " > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `update()` will fail and issue an error." ], "links": [], "examples": @@ -3025,7 +3035,7 @@ "messages": [ { "name": "WixDataBulkRemoveResult", "locations": - [ { "lineno": 466, + [ { "lineno": 467, "filename": "data-api.js" } ], "docs": { "summary": "An object returned by the `bulkRemove()` function.", @@ -3057,7 +3067,7 @@ "labels": [] }, { "name": "WixDataBulkResult", "locations": - [ { "lineno": 857, + [ { "lineno": 858, "filename": "data-api.js" } ], "docs": { "summary": "An object returned by Wix Data bulk operations.", @@ -3161,7 +3171,7 @@ "optional": true }, { "name": "consistentRead", "type": "boolean", - "doc": "When `true`, reads data from the primary database instance. \nThis decreases performance but ensures data retrieved is up to date even immediately after an update. \nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n\nDefault: `false`", + "doc": "When `true`, reads data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n\nDefault: `false`", "optional": true }, { "name": "fields", "type": @@ -3236,11 +3246,11 @@ "optional": true }, { "name": "consistentRead", "type": "boolean", - "doc": "When `true`, reads data from the primary database instance. \nThis decreases performance but ensures data retrieved is up to date even immediately after an update. \nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n\nDefault: `false`", + "doc": "When `true`, reads data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n\nDefault: `false`", "optional": true }, { "name": "omitTotalCount", "type": "boolean", - "doc": "When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query. \nThis speeds up the query.\n\nDefault: `false`", + "doc": "When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query.\nThis speeds up the query.\n\nDefault: `false`", "optional": true }, { "name": "appOptions", "type": "wix-data.WixStoresProductQuery", @@ -3263,7 +3273,7 @@ [ "changed" ] }, { "name": "WixDataQueryReferencedOptions", "locations": - [ { "lineno": 640, + [ { "lineno": 641, "filename": "data-api.js" } ], "docs": { "summary": "An object for controlling the order of returned referenced items.", @@ -3317,7 +3327,7 @@ "members": [ { "name": "order", "type": "string", - "doc": "Order of the returned referenced items. Sorted by the date each item was referenced. \n\nSupported values:\n- `'asc'`: Ascending\n- `'desc'`: Descending", + "doc": "Order of the returned referenced items. Sorted by the date each item was referenced.\n\nSupported values:\n- `'asc'`: Ascending\n- `'desc'`: Descending", "optional": true }, { "name": "suppressAuth", "type": "boolean", @@ -3325,11 +3335,11 @@ "optional": true }, { "name": "consistentRead", "type": "boolean", - "doc": "When `true`, reads data from the primary database instance. \nThis decreases performance but ensures data retrieved is up to date even immediately after an update. \nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n\nDefault: `false`", + "doc": "When `true`, reads data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nSee [Wix Data and Eventual Consistency](https://www.wix.com/velo/reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n\nDefault: `false`", "optional": true }, { "name": "omitTotalCount", "type": "boolean", - "doc": "When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query. \nThis speeds up the query.\n\n\nDefault: `false`", + "doc": "When `true`, the query result does not include a `totalCount` property containing the total number of items matching the query.\nThis speeds up the query.\n\n\nDefault: `false`", "optional": true }, { "name": "fields", "type":