@wix/wix-data-items-sdk 1.0.537 → 1.0.538

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21,7 +21,7 @@ import { DataItemCreatedEnvelope, DataItemDeletedEnvelope, DataItemUpdatedEnvelo
21
21
  * When inserting an item into a collection that has a multi-reference field, set the
22
22
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
23
23
  * entire referenced item objects.
24
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
24
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
25
25
  *
26
26
  * The `insert()` method adds the following properties and values to the item
27
27
  * when it adds it to the collection:
@@ -82,7 +82,7 @@ export declare function insert<Item extends Record<string, any>>(dataCollectionI
82
82
  * When updating an item in a collection that has a multi-reference field, set the
83
83
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
84
84
  * entire referenced item objects.
85
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
85
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
86
86
  *
87
87
  * The maximum size of an item that you can update in a collection is 500kb.
88
88
  *
@@ -129,7 +129,7 @@ export declare function update<Item extends WithId>(dataCollectionId: string, it
129
129
  * When saving an item to a collection that has a multi-reference field, set the
130
130
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
131
131
  * entire referenced item objects.
132
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
132
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
133
133
  *
134
134
  * > **Notes:**
135
135
  * > - The maximum size of an item that you can save to a collection is 500kb.
@@ -244,7 +244,7 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
244
244
  * When inserting items into a collection that has a multi-reference field, set the
245
245
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
246
246
  * entire referenced item objects.
247
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
247
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
248
248
  *
249
249
  * The `bulkInsert()` method adds the following properties and values to the
250
250
  * item when it adds it to the collection:
@@ -311,7 +311,7 @@ export declare function bulkInsert<Item extends Record<string, any>>(dataCollect
311
311
  * When updating items in a collection that has a multi-reference field, set the
312
312
  * values of the multi-reference field to arrays of the referenced items' `_id` values or arrays of the
313
313
  * entire referenced item objects.
314
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
314
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
315
315
  *
316
316
  * > **Notes:**
317
317
  * > - The maximum size of an item that you can update in a collection is 500kb.
@@ -358,7 +358,7 @@ export declare function bulkUpdate<Item extends WithId>(dataCollectionId: string
358
358
  * When saving items to a collection that has a multi-reference field, set the
359
359
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
360
360
  * entire referenced item objects.
361
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
361
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
362
362
  *
363
363
  * > **Notes:**
364
364
  * > - The maximum size of an item that you can save to a collection is 500kb.
@@ -673,7 +673,7 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
673
673
  /**
674
674
  * Runs an aggregation pipeline on a data collection and returns the results.
675
675
  *
676
- * Aggregations enable you to perform advanced data calculations, transformations, and groupings. Aggregations are perfomed sequentially in stages, with each stage transforming the results of the previous stage.
676
+ * Aggregations enable you to perform advanced data calculations, transformations, and groupings. Aggregations are performed sequentially in stages, with each stage transforming the results of the previous stage.
677
677
  *
678
678
  * When calling the `aggregate()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`PipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages and configure paging.
679
679
  *
@@ -96,7 +96,7 @@ Object.defineProperty(exports, "FieldModificationsBuilder", { enumerable: true,
96
96
  * When inserting an item into a collection that has a multi-reference field, set the
97
97
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
98
98
  * entire referenced item objects.
99
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
99
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
100
100
  *
101
101
  * The `insert()` method adds the following properties and values to the item
102
102
  * when it adds it to the collection:
@@ -160,7 +160,7 @@ async function insert(dataCollectionId, item, options) {
160
160
  * When updating an item in a collection that has a multi-reference field, set the
161
161
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
162
162
  * entire referenced item objects.
163
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
163
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
164
164
  *
165
165
  * The maximum size of an item that you can update in a collection is 500kb.
166
166
  *
@@ -210,7 +210,7 @@ async function update(dataCollectionId, item, options) {
210
210
  * When saving an item to a collection that has a multi-reference field, set the
211
211
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
212
212
  * entire referenced item objects.
213
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
213
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
214
214
  *
215
215
  * > **Notes:**
216
216
  * > - The maximum size of an item that you can save to a collection is 500kb.
@@ -337,7 +337,7 @@ async function truncate(dataCollectionId) {
337
337
  * When inserting items into a collection that has a multi-reference field, set the
338
338
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
339
339
  * entire referenced item objects.
340
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
340
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
341
341
  *
342
342
  * The `bulkInsert()` method adds the following properties and values to the
343
343
  * item when it adds it to the collection:
@@ -407,7 +407,7 @@ async function bulkInsert(dataCollectionId, items, options) {
407
407
  * When updating items in a collection that has a multi-reference field, set the
408
408
  * values of the multi-reference field to arrays of the referenced items' `_id` values or arrays of the
409
409
  * entire referenced item objects.
410
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
410
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
411
411
  *
412
412
  * > **Notes:**
413
413
  * > - The maximum size of an item that you can update in a collection is 500kb.
@@ -457,7 +457,7 @@ async function bulkUpdate(dataCollectionId, items, options) {
457
457
  * When saving items to a collection that has a multi-reference field, set the
458
458
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
459
459
  * entire referenced item objects.
460
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
460
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
461
461
  *
462
462
  * > **Notes:**
463
463
  * > - The maximum size of an item that you can save to a collection is 500kb.
@@ -21,7 +21,7 @@ import { DataItemCreatedEnvelope, DataItemDeletedEnvelope, DataItemUpdatedEnvelo
21
21
  * When inserting an item into a collection that has a multi-reference field, set the
22
22
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
23
23
  * entire referenced item objects.
24
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
24
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
25
25
  *
26
26
  * The `insert()` method adds the following properties and values to the item
27
27
  * when it adds it to the collection:
@@ -82,7 +82,7 @@ export declare function insert<Item extends Record<string, any>>(dataCollectionI
82
82
  * When updating an item in a collection that has a multi-reference field, set the
83
83
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
84
84
  * entire referenced item objects.
85
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
85
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
86
86
  *
87
87
  * The maximum size of an item that you can update in a collection is 500kb.
88
88
  *
@@ -129,7 +129,7 @@ export declare function update<Item extends WithId>(dataCollectionId: string, it
129
129
  * When saving an item to a collection that has a multi-reference field, set the
130
130
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
131
131
  * entire referenced item objects.
132
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
132
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
133
133
  *
134
134
  * > **Notes:**
135
135
  * > - The maximum size of an item that you can save to a collection is 500kb.
@@ -244,7 +244,7 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
244
244
  * When inserting items into a collection that has a multi-reference field, set the
245
245
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
246
246
  * entire referenced item objects.
247
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
247
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
248
248
  *
249
249
  * The `bulkInsert()` method adds the following properties and values to the
250
250
  * item when it adds it to the collection:
@@ -311,7 +311,7 @@ export declare function bulkInsert<Item extends Record<string, any>>(dataCollect
311
311
  * When updating items in a collection that has a multi-reference field, set the
312
312
  * values of the multi-reference field to arrays of the referenced items' `_id` values or arrays of the
313
313
  * entire referenced item objects.
314
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
314
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
315
315
  *
316
316
  * > **Notes:**
317
317
  * > - The maximum size of an item that you can update in a collection is 500kb.
@@ -358,7 +358,7 @@ export declare function bulkUpdate<Item extends WithId>(dataCollectionId: string
358
358
  * When saving items to a collection that has a multi-reference field, set the
359
359
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
360
360
  * entire referenced item objects.
361
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
361
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
362
362
  *
363
363
  * > **Notes:**
364
364
  * > - The maximum size of an item that you can save to a collection is 500kb.
@@ -673,7 +673,7 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
673
673
  /**
674
674
  * Runs an aggregation pipeline on a data collection and returns the results.
675
675
  *
676
- * Aggregations enable you to perform advanced data calculations, transformations, and groupings. Aggregations are perfomed sequentially in stages, with each stage transforming the results of the previous stage.
676
+ * Aggregations enable you to perform advanced data calculations, transformations, and groupings. Aggregations are performed sequentially in stages, with each stage transforming the results of the previous stage.
677
677
  *
678
678
  * When calling the `aggregate()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`PipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages and configure paging.
679
679
  *
@@ -20,7 +20,7 @@ import { QueryBase, pipelineBuilder, QueryBuilder, Sort, Filter, InsertOptionsBu
20
20
  * When inserting an item into a collection that has a multi-reference field, set the
21
21
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
22
22
  * entire referenced item objects.
23
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
23
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
24
24
  *
25
25
  * The `insert()` method adds the following properties and values to the item
26
26
  * when it adds it to the collection:
@@ -84,7 +84,7 @@ export async function insert(dataCollectionId, item, options) {
84
84
  * When updating an item in a collection that has a multi-reference field, set the
85
85
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
86
86
  * entire referenced item objects.
87
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
87
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
88
88
  *
89
89
  * The maximum size of an item that you can update in a collection is 500kb.
90
90
  *
@@ -134,7 +134,7 @@ export async function update(dataCollectionId, item, options) {
134
134
  * When saving an item to a collection that has a multi-reference field, set the
135
135
  * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
136
136
  * entire referenced item objects.
137
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
137
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
138
138
  *
139
139
  * > **Notes:**
140
140
  * > - The maximum size of an item that you can save to a collection is 500kb.
@@ -261,7 +261,7 @@ export async function truncate(dataCollectionId) {
261
261
  * When inserting items into a collection that has a multi-reference field, set the
262
262
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
263
263
  * entire referenced item objects.
264
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
264
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
265
265
  *
266
266
  * The `bulkInsert()` method adds the following properties and values to the
267
267
  * item when it adds it to the collection:
@@ -331,7 +331,7 @@ export async function bulkInsert(dataCollectionId, items, options) {
331
331
  * When updating items in a collection that has a multi-reference field, set the
332
332
  * values of the multi-reference field to arrays of the referenced items' `_id` values or arrays of the
333
333
  * entire referenced item objects.
334
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
334
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
335
335
  *
336
336
  * > **Notes:**
337
337
  * > - The maximum size of an item that you can update in a collection is 500kb.
@@ -381,7 +381,7 @@ export async function bulkUpdate(dataCollectionId, items, options) {
381
381
  * When saving items to a collection that has a multi-reference field, set the
382
382
  * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
383
383
  * entire referenced item objects.
384
- * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
384
+ * To save multi-reference values, specify `saveReferences: true` in the `options` object.
385
385
  *
386
386
  * > **Notes:**
387
387
  * > - The maximum size of an item that you can save to a collection is 500kb.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/wix-data-items-sdk",
3
- "version": "1.0.537",
3
+ "version": "1.0.538",
4
4
  "license": "UNLICENSED",
5
5
  "author": {
6
6
  "name": "Rimvydas Gimbutas",
@@ -36,7 +36,7 @@
36
36
  "dependencies": {
37
37
  "@wix/sdk-runtime": "^0.7.0",
38
38
  "@wix/sdk-types": "^1.17.9",
39
- "@wix/wix-data-items-common": "1.0.319"
39
+ "@wix/wix-data-items-common": "1.0.320"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@eslint/js": "^9.39.1",
@@ -95,5 +95,5 @@
95
95
  "wallaby": {
96
96
  "autoDetect": true
97
97
  },
98
- "falconPackageHash": "233e96f9a669e2b477a5c6562141311b24b034236055932ad8b9322c"
98
+ "falconPackageHash": "9a09b9f052c11a7c43c4b3cb04667b577a6f522a45c0446692195e47"
99
99
  }