Skip to content

DocWorks for wix-data - 10 changes detected, but 12 issue detected #3345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

DocWorks for wix-data - 10 changes detected, but 12 issue detected #3345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion wix-data/DataHooks.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{ "name": "DataHooks",
"mixes": [],
"labels": [],
"labels":
[ "removed" ],
"location":
{ "lineno": 20,
"filename": "hooks-standalone.js" },
Expand Down
62 changes: 36 additions & 26 deletions wix-data/wix-data.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{ "name": "wix-data",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 72,
"filename": "data-api.js" },
Expand Down Expand Up @@ -152,7 +153,7 @@
{ "type": "wix-data.WixDataAggregate",
"doc": "An aggregate object." },
"locations":
[ { "lineno": 1069,
[ { "lineno": 1075,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Creates an aggregation.",
Expand Down Expand Up @@ -253,7 +254,7 @@
[ "wix-data.WixDataBulkResult" ] },
"doc": "Fulfilled - The results of the bulk insert.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 883,
[ { "lineno": 889,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Adds a number of items to a collection.",
Expand Down Expand Up @@ -522,7 +523,7 @@
[ "wix-data.WixDataBulkRemoveResult" ] },
"doc": "Fulfilled - The results of the bulk remove.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 490,
[ { "lineno": 495,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Removes a number of items from a collection.",
Expand Down Expand Up @@ -636,7 +637,7 @@
[ "wix-data.WixDataBulkResult" ] },
"doc": "Fulfilled - The results of the bulk save.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 946,
[ { "lineno": 952,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Inserts or updates a number of items in a collection.",
Expand Down Expand Up @@ -904,7 +905,7 @@
[ "wix-data.WixDataBulkResult" ] },
"doc": "Fulfilled - The results of the bulk save.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 1007,
[ { "lineno": 1013,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Updates a number of items in a collection.",
Expand Down Expand Up @@ -1107,7 +1108,7 @@
{ "type": "wix-data.WixDataFilter",
"doc": "A filter object." },
"locations":
[ { "lineno": 378,
[ { "lineno": 383,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Creates a filter to be used with datasets and aggregations.",
Expand Down Expand Up @@ -1135,7 +1136,8 @@
"extra":
{ } },
{ "name": "get",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "collectionId",
Expand Down Expand Up @@ -1177,6 +1179,8 @@
" > **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](https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_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.",
" > - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results).",
" > - 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](https://dev.wix.com/docs/velo/api-reference/wix-data-v2/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.",
" > - To speed up data retrieval, the results of certain data requests are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results).",
" > - An `itemId` is required to retrieve an item even from a single-item collection." ],
"links": [],
"examples":
Expand Down Expand Up @@ -1266,7 +1270,7 @@
[ "Object" ] },
"doc": "Fulfilled - The item that was added.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 248,
[ { "lineno": 250,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Adds an item to a collection.",
Expand Down Expand Up @@ -1554,7 +1558,7 @@
[ "void" ] },
"doc": "Fulfilled - When the references have been inserted.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 737,
[ { "lineno": 743,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Inserts a reference in the specified property.",
Expand Down Expand Up @@ -1638,7 +1642,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": 839,
[ { "lineno": 845,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Checks if a reference to the referenced item exists in the specified\n property of the referring item.",
Expand Down Expand Up @@ -1674,7 +1678,8 @@
"extra":
{ } },
{ "name": "query",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "collectionId",
Expand All @@ -1684,7 +1689,7 @@
{ "type": "wix-data.WixDataQuery",
"doc": "A query object." },
"locations":
[ { "lineno": 310,
[ { "lineno": 312,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Creates a query for retrieving items from a database collection.",
Expand Down Expand Up @@ -1732,7 +1737,10 @@
"",
" > **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]https://dev.wix.com/docs/velo/api-reference/wix-data/introduction#api-reference_wix-data_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.",
"> - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results)." ],
"> - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results).",
" > **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](https://dev.wix.com/docs/velo/api-reference/wix-data-v2/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.",
" > - To speed up data retrieval, the results of certain data requests are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results)." ],
"links": [],
"examples":
[ { "title": "Build a query",
Expand Down Expand Up @@ -1927,7 +1935,8 @@
"extra":
{ } },
{ "name": "queryReferenced",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "collectionId",
Expand All @@ -1952,7 +1961,7 @@
[ "wix-data.WixDataQueryReferencedResult" ] },
"doc": "Fulfilled - The referenced items.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 687,
[ { "lineno": 692,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Gets the full items referenced in the specified property.",
Expand Down Expand Up @@ -1981,6 +1990,7 @@
" > - 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.",
" > - To speed up data retrieval, the results of certain data requests are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results).",
"",
" For a discussion of when to use the similar [`include()`](https://dev.wix.com/docs/velo/api-reference/wix-data/wix-data-query/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)." ],
Expand Down Expand Up @@ -2078,7 +2088,7 @@
[ "Object" ] },
"doc": "Fulfilled - The removed item, or `null` if the item was not found.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 406,
[ { "lineno": 411,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Removes an item from a collection.",
Expand Down Expand Up @@ -2215,7 +2225,7 @@
[ "void" ] },
"doc": "Fulfilled - When the references have been removed.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 806,
[ { "lineno": 812,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Removes a reference from the specified property.",
Expand Down Expand Up @@ -2303,7 +2313,7 @@
[ "void" ] },
"doc": "Fulfilled - When the references have been inserted.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 772,
[ { "lineno": 778,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Replaces current references with references in the specified property.",
Expand Down Expand Up @@ -2375,7 +2385,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": 530,
[ { "lineno": 535,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Inserts or updates an item in a collection.",
Expand Down Expand Up @@ -2611,7 +2621,7 @@
{ "type": "wix-data.WixDataSort",
"doc": "A sort object." },
"locations":
[ { "lineno": 392,
[ { "lineno": 397,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Creates a sort to be used with the dataset `setSort()` function.",
Expand Down Expand Up @@ -2656,7 +2666,7 @@
[ "null" ] },
"doc": "Fulfilled - When the items have been removed.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 446,
[ { "lineno": 451,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Removes all items from a collection.",
Expand Down Expand Up @@ -2737,7 +2747,7 @@
[ "Object" ] },
"doc": "Fulfilled - The object that was updated.\nRejected - The error that caused the rejection." },
"locations":
[ { "lineno": 586,
[ { "lineno": 591,
"filename": "data-api.js" } ],
"docs":
{ "summary": "Updates an item in a collection.",
Expand Down Expand Up @@ -3042,7 +3052,7 @@
"messages":
[ { "name": "WixDataBulkRemoveResult",
"locations":
[ { "lineno": 480,
[ { "lineno": 485,
"filename": "data-api.js" } ],
"docs":
{ "summary": "An object returned by the `bulkRemove()` function.",
Expand Down Expand Up @@ -3074,7 +3084,7 @@
"labels": [] },
{ "name": "WixDataBulkResult",
"locations":
[ { "lineno": 871,
[ { "lineno": 877,
"filename": "data-api.js" } ],
"docs":
{ "summary": "An object returned by Wix Data bulk operations.",
Expand Down Expand Up @@ -3264,7 +3274,7 @@
"labels": [] },
{ "name": "WixDataQueryReferencedOptions",
"locations":
[ { "lineno": 654,
[ { "lineno": 659,
"filename": "data-api.js" } ],
"docs":
{ "summary": "An object for controlling the order of returned referenced items.",
Expand Down
Loading