@ahoo-wang/wow-client 10.0.0-alpha.5 → 10.0.0-alpha.7
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.
- package/README.md +76 -23
- package/README.zh-CN.md +66 -19
- package/dist/commands.cjs +1 -1
- package/dist/commands.cjs.map +1 -1
- package/dist/commands.d.cts +131 -61
- package/dist/commands.d.ts +131 -61
- package/dist/commands.es.js +117 -59
- package/dist/commands.es.js.map +1 -1
- package/dist/developmentCaller.cjs +2 -0
- package/dist/developmentCaller.cjs.map +1 -0
- package/dist/developmentCaller.d.cts +61 -0
- package/dist/developmentCaller.d.ts +61 -0
- package/dist/developmentCaller.es.js +26 -0
- package/dist/developmentCaller.es.js.map +1 -0
- package/dist/dsl/aggregation/admit.cjs +1 -1
- package/dist/dsl/aggregation/admit.cjs.map +1 -1
- package/dist/dsl/aggregation/admit.es.js +93 -93
- package/dist/dsl/aggregation/admit.es.js.map +1 -1
- package/dist/dsl/aggregation/builders.cjs +1 -1
- package/dist/dsl/aggregation/builders.cjs.map +1 -1
- package/dist/dsl/aggregation/builders.d.cts +20 -20
- package/dist/dsl/aggregation/builders.d.ts +20 -20
- package/dist/dsl/aggregation/builders.es.js +88 -88
- package/dist/dsl/aggregation/builders.es.js.map +1 -1
- package/dist/dsl/aggregation/derived.cjs.map +1 -1
- package/dist/dsl/aggregation/derived.d.cts +8 -8
- package/dist/dsl/aggregation/derived.d.ts +8 -8
- package/dist/dsl/aggregation/derived.es.js +1 -2
- package/dist/dsl/aggregation/derived.es.js.map +1 -1
- package/dist/dsl/aggregation/expressionTrees.cjs.map +1 -1
- package/dist/dsl/aggregation/expressionTrees.es.js +1 -2
- package/dist/dsl/aggregation/having.cjs +1 -1
- package/dist/dsl/aggregation/having.cjs.map +1 -1
- package/dist/dsl/aggregation/having.d.cts +12 -12
- package/dist/dsl/aggregation/having.d.ts +12 -12
- package/dist/dsl/aggregation/having.es.js +33 -33
- package/dist/dsl/aggregation/having.es.js.map +1 -1
- package/dist/dsl/aggregation/sort.cjs.map +1 -1
- package/dist/dsl/aggregation/sort.es.js +1 -2
- package/dist/dsl/aggregation/types.cjs +1 -1
- package/dist/dsl/aggregation/types.cjs.map +1 -1
- package/dist/dsl/aggregation/types.d.cts +69 -69
- package/dist/dsl/aggregation/types.d.ts +69 -69
- package/dist/dsl/aggregation/types.es.js +15 -16
- package/dist/dsl/aggregation/types.es.js.map +1 -1
- package/dist/dsl/constantName.cjs +2 -0
- package/dist/dsl/constantName.cjs.map +1 -0
- package/dist/dsl/constantName.d.cts +9 -0
- package/dist/dsl/constantName.d.ts +9 -0
- package/dist/dsl/constantName.es.js +7 -0
- package/dist/dsl/constantName.es.js.map +1 -0
- package/dist/dsl/cursorQuery.cjs.map +1 -1
- package/dist/dsl/cursorQuery.es.js +1 -2
- package/dist/dsl/deletionState.cjs +1 -1
- package/dist/dsl/deletionState.cjs.map +1 -1
- package/dist/dsl/deletionState.d.cts +3 -3
- package/dist/dsl/deletionState.d.ts +3 -3
- package/dist/dsl/deletionState.es.js +2 -3
- package/dist/dsl/deletionState.es.js.map +1 -1
- package/dist/dsl/descriptor.cjs +1 -1
- package/dist/dsl/descriptor.cjs.map +1 -1
- package/dist/dsl/descriptor.d.cts +92 -42
- package/dist/dsl/descriptor.d.ts +92 -42
- package/dist/dsl/descriptor.es.js +36 -29
- package/dist/dsl/descriptor.es.js.map +1 -1
- package/dist/dsl/field.cjs.map +1 -1
- package/dist/dsl/field.es.js +1 -2
- package/dist/dsl/filter/builders.cjs +1 -1
- package/dist/dsl/filter/builders.cjs.map +1 -1
- package/dist/dsl/filter/builders.d.cts +53 -53
- package/dist/dsl/filter/builders.d.ts +53 -53
- package/dist/dsl/filter/builders.es.js +111 -111
- package/dist/dsl/filter/builders.es.js.map +1 -1
- package/dist/dsl/filter/datePattern.cjs.map +1 -1
- package/dist/dsl/filter/datePattern.es.js +1 -2
- package/dist/dsl/filter/operator.cjs +1 -1
- package/dist/dsl/filter/operator.cjs.map +1 -1
- package/dist/dsl/filter/operator.d.cts +57 -57
- package/dist/dsl/filter/operator.d.ts +57 -57
- package/dist/dsl/filter/operator.es.js +4 -5
- package/dist/dsl/filter/operator.es.js.map +1 -1
- package/dist/dsl/filter/scope.cjs +1 -1
- package/dist/dsl/filter/scope.cjs.map +1 -1
- package/dist/dsl/filter/scope.es.js +12 -12
- package/dist/dsl/filter/scope.es.js.map +1 -1
- package/dist/dsl/filter/validate.cjs +1 -1
- package/dist/dsl/filter/validate.cjs.map +1 -1
- package/dist/dsl/filter/validate.es.js +23 -23
- package/dist/dsl/filter/validate.es.js.map +1 -1
- package/dist/dsl/pagination.cjs.map +1 -1
- package/dist/dsl/pagination.es.js +1 -2
- package/dist/dsl/projection.cjs.map +1 -1
- package/dist/dsl/projection.d.cts +1 -1
- package/dist/dsl/projection.d.ts +1 -1
- package/dist/dsl/projection.es.js +1 -2
- package/dist/dsl/projection.es.js.map +1 -1
- package/dist/dsl/queryErrorCodes.cjs +1 -1
- package/dist/dsl/queryErrorCodes.cjs.map +1 -1
- package/dist/dsl/queryErrorCodes.d.cts +59 -48
- package/dist/dsl/queryErrorCodes.d.ts +59 -48
- package/dist/dsl/queryErrorCodes.es.js +51 -50
- package/dist/dsl/queryErrorCodes.es.js.map +1 -1
- package/dist/dsl/queryable.cjs +1 -1
- package/dist/dsl/queryable.cjs.map +1 -1
- package/dist/dsl/queryable.d.cts +25 -21
- package/dist/dsl/queryable.d.ts +25 -21
- package/dist/dsl/queryable.es.js +5 -5
- package/dist/dsl/queryable.es.js.map +1 -1
- package/dist/dsl/sort.cjs +1 -1
- package/dist/dsl/sort.cjs.map +1 -1
- package/dist/dsl/sort.d.cts +2 -2
- package/dist/dsl/sort.d.ts +2 -2
- package/dist/dsl/sort.es.js +4 -5
- package/dist/dsl/sort.es.js.map +1 -1
- package/dist/dsl.cjs +1 -1
- package/dist/dsl.es.js +3 -3
- package/dist/exactJson.cjs.map +1 -1
- package/dist/exactJson.d.cts +4 -4
- package/dist/exactJson.d.ts +4 -4
- package/dist/exactJson.es.js +1 -2
- package/dist/exactJson.es.js.map +1 -1
- package/dist/frameworkErrors.cjs +2 -0
- package/dist/frameworkErrors.cjs.map +1 -0
- package/dist/frameworkErrors.d.cts +121 -0
- package/dist/frameworkErrors.d.ts +121 -0
- package/dist/frameworkErrors.es.js +95 -0
- package/dist/frameworkErrors.es.js.map +1 -0
- package/dist/http.cjs +1 -1
- package/dist/http.cjs.map +1 -1
- package/dist/http.d.cts +4 -7
- package/dist/http.d.ts +4 -7
- package/dist/http.es.js +12 -20
- package/dist/http.es.js.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +9 -7
- package/dist/index.d.ts +9 -7
- package/dist/index.es.js +11 -9
- package/dist/manifest.cjs +1 -1
- package/dist/manifest.cjs.map +1 -1
- package/dist/manifest.d.cts +33 -95
- package/dist/manifest.d.ts +33 -95
- package/dist/manifest.es.js +12 -7
- package/dist/manifest.es.js.map +1 -1
- package/dist/manifestTypes.d.cts +193 -0
- package/dist/manifestTypes.d.ts +193 -0
- package/dist/problem.cjs +1 -1
- package/dist/problem.cjs.map +1 -1
- package/dist/problem.d.cts +76 -111
- package/dist/problem.d.ts +76 -111
- package/dist/problem.es.js +45 -78
- package/dist/problem.es.js.map +1 -1
- package/dist/queries.cjs +1 -1
- package/dist/queries.cjs.map +1 -1
- package/dist/queries.d.cts +28 -51
- package/dist/queries.d.ts +28 -51
- package/dist/queries.es.js +49 -40
- package/dist/queries.es.js.map +1 -1
- package/dist/routes.cjs +2 -0
- package/dist/routes.cjs.map +1 -0
- package/dist/routes.d.cts +49 -0
- package/dist/routes.d.ts +49 -0
- package/dist/routes.es.js +33 -0
- package/dist/routes.es.js.map +1 -0
- package/dist/state.cjs +1 -1
- package/dist/state.cjs.map +1 -1
- package/dist/state.d.cts +56 -11
- package/dist/state.d.ts +56 -11
- package/dist/state.es.js +56 -21
- package/dist/state.es.js.map +1 -1
- package/dist/streams.cjs +1 -1
- package/dist/streams.cjs.map +1 -1
- package/dist/streams.d.cts +17 -13
- package/dist/streams.d.ts +17 -13
- package/dist/streams.es.js +50 -50
- package/dist/streams.es.js.map +1 -1
- package/dist/testing/wire.cjs +2 -0
- package/dist/testing/wire.cjs.map +1 -0
- package/dist/testing/wire.d.cts +29 -0
- package/dist/testing/wire.d.ts +29 -0
- package/dist/testing/wire.es.js +88 -0
- package/dist/testing/wire.es.js.map +1 -0
- package/dist/testing.cjs +1 -0
- package/dist/testing.d.cts +12 -0
- package/dist/testing.d.ts +12 -0
- package/dist/testing.es.js +3 -0
- package/dist/wait.cjs +1 -1
- package/dist/wait.cjs.map +1 -1
- package/dist/wait.d.cts +67 -18
- package/dist/wait.d.ts +67 -18
- package/dist/wait.es.js +59 -12
- package/dist/wait.es.js.map +1 -1
- package/dist/wire.cjs +1 -1
- package/dist/wire.cjs.map +1 -1
- package/dist/wire.d.cts +100 -50
- package/dist/wire.d.ts +100 -50
- package/dist/wire.es.js +17 -6
- package/dist/wire.es.js.map +1 -1
- package/package.json +26 -7
|
@@ -55,7 +55,7 @@ export declare const filter: {
|
|
|
55
55
|
/**
|
|
56
56
|
* Matches every record in the query scope.
|
|
57
57
|
*
|
|
58
|
-
* @returns `{ op: '
|
|
58
|
+
* @returns `{ op: 'match-all' }`.
|
|
59
59
|
* @example
|
|
60
60
|
* ```typescript
|
|
61
61
|
* filter.matchAll();
|
|
@@ -65,7 +65,7 @@ export declare const filter: {
|
|
|
65
65
|
/**
|
|
66
66
|
* Matches no record.
|
|
67
67
|
*
|
|
68
|
-
* @returns `{ op: '
|
|
68
|
+
* @returns `{ op: 'match-none' }`.
|
|
69
69
|
* @example
|
|
70
70
|
* ```typescript
|
|
71
71
|
* filter.matchNone();
|
|
@@ -77,7 +77,7 @@ export declare const filter: {
|
|
|
77
77
|
* inside `elementMatch`.
|
|
78
78
|
*
|
|
79
79
|
* @param value - The record ID.
|
|
80
|
-
* @returns `{ op: '
|
|
80
|
+
* @returns `{ op: 'id', value }`.
|
|
81
81
|
* @throws TypeError If `value` is not a string.
|
|
82
82
|
* @example
|
|
83
83
|
* ```typescript
|
|
@@ -90,7 +90,7 @@ export declare const filter: {
|
|
|
90
90
|
* allowed inside `elementMatch`.
|
|
91
91
|
*
|
|
92
92
|
* @param values - Non-empty list of record IDs.
|
|
93
|
-
* @returns `{ op: '
|
|
93
|
+
* @returns `{ op: 'ids', values }` with a copy of `values`.
|
|
94
94
|
* @throws TypeError If `values` is empty, contains `null` or `undefined`,
|
|
95
95
|
* or contains a non-string.
|
|
96
96
|
* @example
|
|
@@ -104,7 +104,7 @@ export declare const filter: {
|
|
|
104
104
|
* inside `elementMatch`.
|
|
105
105
|
*
|
|
106
106
|
* @param value - The aggregate ID.
|
|
107
|
-
* @returns `{ op: '
|
|
107
|
+
* @returns `{ op: 'aggregate-id', value }`.
|
|
108
108
|
* @throws TypeError If `value` is not a string.
|
|
109
109
|
* @example
|
|
110
110
|
* ```typescript
|
|
@@ -117,7 +117,7 @@ export declare const filter: {
|
|
|
117
117
|
* allowed inside `elementMatch`.
|
|
118
118
|
*
|
|
119
119
|
* @param values - Non-empty list of aggregate IDs.
|
|
120
|
-
* @returns `{ op: '
|
|
120
|
+
* @returns `{ op: 'aggregate-ids', values }` with a copy of `values`.
|
|
121
121
|
* @throws TypeError If `values` is empty, contains `null` or `undefined`,
|
|
122
122
|
* or contains a non-string.
|
|
123
123
|
* @example
|
|
@@ -131,7 +131,7 @@ export declare const filter: {
|
|
|
131
131
|
* inside `elementMatch`.
|
|
132
132
|
*
|
|
133
133
|
* @param value - The tenant ID.
|
|
134
|
-
* @returns `{ op: '
|
|
134
|
+
* @returns `{ op: 'tenant-id', value }`.
|
|
135
135
|
* @throws TypeError If `value` is not a string.
|
|
136
136
|
* @example
|
|
137
137
|
* ```typescript
|
|
@@ -144,7 +144,7 @@ export declare const filter: {
|
|
|
144
144
|
* inside `elementMatch`.
|
|
145
145
|
*
|
|
146
146
|
* @param value - The owner ID.
|
|
147
|
-
* @returns `{ op: '
|
|
147
|
+
* @returns `{ op: 'owner-id', value }`.
|
|
148
148
|
* @throws TypeError If `value` is not a string.
|
|
149
149
|
* @example
|
|
150
150
|
* ```typescript
|
|
@@ -157,7 +157,7 @@ export declare const filter: {
|
|
|
157
157
|
* inside `elementMatch`.
|
|
158
158
|
*
|
|
159
159
|
* @param value - The space ID.
|
|
160
|
-
* @returns `{ op: '
|
|
160
|
+
* @returns `{ op: 'space-id', value }`.
|
|
161
161
|
* @throws TypeError If `value` is not a string.
|
|
162
162
|
* @example
|
|
163
163
|
* ```typescript
|
|
@@ -171,7 +171,7 @@ export declare const filter: {
|
|
|
171
171
|
* inside `elementMatch`.
|
|
172
172
|
*
|
|
173
173
|
* @param operands - Non-empty list of filter expressions.
|
|
174
|
-
* @returns `{ op: '
|
|
174
|
+
* @returns `{ op: 'and', operands }` with a copy of `operands`.
|
|
175
175
|
* @throws TypeError If `operands` is empty or contains `null` or
|
|
176
176
|
* `undefined`.
|
|
177
177
|
* @example
|
|
@@ -189,7 +189,7 @@ export declare const filter: {
|
|
|
189
189
|
* inside `elementMatch`.
|
|
190
190
|
*
|
|
191
191
|
* @param operands - Non-empty list of filter expressions.
|
|
192
|
-
* @returns `{ op: '
|
|
192
|
+
* @returns `{ op: 'or', operands }` with a copy of `operands`.
|
|
193
193
|
* @throws TypeError If `operands` is empty or contains `null` or
|
|
194
194
|
* `undefined`.
|
|
195
195
|
* @example
|
|
@@ -207,7 +207,7 @@ export declare const filter: {
|
|
|
207
207
|
* inside `elementMatch`.
|
|
208
208
|
*
|
|
209
209
|
* @param operands - Non-empty list of filter expressions.
|
|
210
|
-
* @returns `{ op: '
|
|
210
|
+
* @returns `{ op: 'nor', operands }` with a copy of `operands`.
|
|
211
211
|
* @throws TypeError If `operands` is empty or contains `null` or
|
|
212
212
|
* `undefined`.
|
|
213
213
|
* @example
|
|
@@ -225,7 +225,7 @@ export declare const filter: {
|
|
|
225
225
|
* @param field - Query field path, e.g. `state.status`.
|
|
226
226
|
* @param value - JSON scalar. `null` is sent as is; the server rewrites it
|
|
227
227
|
* to `IS_NULL`.
|
|
228
|
-
* @returns `{ op: '
|
|
228
|
+
* @returns `{ op: 'eq', field, value }`.
|
|
229
229
|
* @throws TypeError If `field` is not a valid query field path, or `value` is not
|
|
230
230
|
* `null`, a string, a boolean or a finite number.
|
|
231
231
|
* @example
|
|
@@ -240,7 +240,7 @@ export declare const filter: {
|
|
|
240
240
|
* @param field - Query field path, e.g. `state.status`.
|
|
241
241
|
* @param value - JSON scalar. `null` is sent as is; the server rewrites it
|
|
242
242
|
* to `IS_NOT_NULL`.
|
|
243
|
-
* @returns `{ op: '
|
|
243
|
+
* @returns `{ op: 'ne', field, value }`.
|
|
244
244
|
* @throws TypeError If `field` is not a valid query field path, or `value` is not
|
|
245
245
|
* `null`, a string, a boolean or a finite number.
|
|
246
246
|
* @example
|
|
@@ -255,7 +255,7 @@ export declare const filter: {
|
|
|
255
255
|
*
|
|
256
256
|
* @param field - Query field path, e.g. `state.status`.
|
|
257
257
|
* @param value - Non-null JSON scalar.
|
|
258
|
-
* @returns `{ op: '
|
|
258
|
+
* @returns `{ op: 'gt', field, value }`.
|
|
259
259
|
* @throws TypeError If `field` is not a valid query field path, or `value` is not a
|
|
260
260
|
* string, a boolean or a finite number.
|
|
261
261
|
* @example
|
|
@@ -270,7 +270,7 @@ export declare const filter: {
|
|
|
270
270
|
*
|
|
271
271
|
* @param field - Query field path, e.g. `state.status`.
|
|
272
272
|
* @param value - Non-null JSON scalar.
|
|
273
|
-
* @returns `{ op: '
|
|
273
|
+
* @returns `{ op: 'gte', field, value }`.
|
|
274
274
|
* @throws TypeError If `field` is not a valid query field path, or `value` is not a
|
|
275
275
|
* string, a boolean or a finite number.
|
|
276
276
|
* @example
|
|
@@ -285,7 +285,7 @@ export declare const filter: {
|
|
|
285
285
|
*
|
|
286
286
|
* @param field - Query field path, e.g. `state.status`.
|
|
287
287
|
* @param value - Non-null JSON scalar.
|
|
288
|
-
* @returns `{ op: '
|
|
288
|
+
* @returns `{ op: 'lt', field, value }`.
|
|
289
289
|
* @throws TypeError If `field` is not a valid query field path, or `value` is not a
|
|
290
290
|
* string, a boolean or a finite number.
|
|
291
291
|
* @example
|
|
@@ -300,7 +300,7 @@ export declare const filter: {
|
|
|
300
300
|
*
|
|
301
301
|
* @param field - Query field path, e.g. `state.status`.
|
|
302
302
|
* @param value - Non-null JSON scalar.
|
|
303
|
-
* @returns `{ op: '
|
|
303
|
+
* @returns `{ op: 'lte', field, value }`.
|
|
304
304
|
* @throws TypeError If `field` is not a valid query field path, or `value` is not a
|
|
305
305
|
* string, a boolean or a finite number.
|
|
306
306
|
* @example
|
|
@@ -317,7 +317,7 @@ export declare const filter: {
|
|
|
317
317
|
* @param value - Literal text.
|
|
318
318
|
* @param stringComparison - Case handling. Defaults to
|
|
319
319
|
* `StringComparison.CASE_SENSITIVE`.
|
|
320
|
-
* @returns `{ op: '
|
|
320
|
+
* @returns `{ op: 'contains', field, value, stringComparison }`.
|
|
321
321
|
* @throws TypeError If `stringComparison` is not a {@link StringComparison}
|
|
322
322
|
* member, `field` is not a valid query field path, or `value` is not a string.
|
|
323
323
|
* @example
|
|
@@ -334,7 +334,7 @@ export declare const filter: {
|
|
|
334
334
|
* @param value - Literal text.
|
|
335
335
|
* @param stringComparison - Case handling. Defaults to
|
|
336
336
|
* `StringComparison.CASE_SENSITIVE`.
|
|
337
|
-
* @returns `{ op: '
|
|
337
|
+
* @returns `{ op: 'starts-with', field, value, stringComparison }`.
|
|
338
338
|
* @throws TypeError If `stringComparison` is not a {@link StringComparison}
|
|
339
339
|
* member, `field` is not a valid query field path, or `value` is not a string.
|
|
340
340
|
* @example
|
|
@@ -351,7 +351,7 @@ export declare const filter: {
|
|
|
351
351
|
* @param value - Literal text.
|
|
352
352
|
* @param stringComparison - Case handling. Defaults to
|
|
353
353
|
* `StringComparison.CASE_SENSITIVE`.
|
|
354
|
-
* @returns `{ op: '
|
|
354
|
+
* @returns `{ op: 'ends-with', field, value, stringComparison }`.
|
|
355
355
|
* @throws TypeError If `stringComparison` is not a {@link StringComparison}
|
|
356
356
|
* member, `field` is not a valid query field path, or `value` is not a string.
|
|
357
357
|
* @example
|
|
@@ -365,7 +365,7 @@ export declare const filter: {
|
|
|
365
365
|
*
|
|
366
366
|
* @param field - Query field path, e.g. `state.status`.
|
|
367
367
|
* @param values - Non-empty list of non-null JSON scalars.
|
|
368
|
-
* @returns `{ op: '
|
|
368
|
+
* @returns `{ op: 'in', field, values }` with a copy of `values`.
|
|
369
369
|
* @throws TypeError If `values` is empty, contains `null` or `undefined`,
|
|
370
370
|
* or contains a value that is not a string, a boolean or a finite
|
|
371
371
|
* number, or if `field` is not a valid query field path.
|
|
@@ -380,7 +380,7 @@ export declare const filter: {
|
|
|
380
380
|
*
|
|
381
381
|
* @param field - Query field path, e.g. `state.status`.
|
|
382
382
|
* @param values - Non-empty list of non-null JSON scalars.
|
|
383
|
-
* @returns `{ op: '
|
|
383
|
+
* @returns `{ op: 'not-in', field, values }` with a copy of `values`.
|
|
384
384
|
* @throws TypeError If `values` is empty, contains `null` or `undefined`,
|
|
385
385
|
* or contains a value that is not a string, a boolean or a finite
|
|
386
386
|
* number, or if `field` is not a valid query field path.
|
|
@@ -395,7 +395,7 @@ export declare const filter: {
|
|
|
395
395
|
*
|
|
396
396
|
* @param field - Query field path, e.g. `state.status`.
|
|
397
397
|
* @param values - Non-empty list of non-null JSON scalars.
|
|
398
|
-
* @returns `{ op: '
|
|
398
|
+
* @returns `{ op: 'contains-all', field, values }` with a copy of `values`.
|
|
399
399
|
* @throws TypeError If `values` is empty, contains `null` or `undefined`,
|
|
400
400
|
* or contains a value that is not a string, a boolean or a finite
|
|
401
401
|
* number, or if `field` is not a valid query field path.
|
|
@@ -412,7 +412,7 @@ export declare const filter: {
|
|
|
412
412
|
* @param field - Query field path, e.g. `state.status`.
|
|
413
413
|
* @param lowerBound - Inclusive lower bound; non-null JSON scalar.
|
|
414
414
|
* @param upperBound - Inclusive upper bound; non-null JSON scalar.
|
|
415
|
-
* @returns `{ op: '
|
|
415
|
+
* @returns `{ op: 'between', field, lowerBound, upperBound }`.
|
|
416
416
|
* @throws TypeError If `field` is not a valid query field path, or either bound is not a
|
|
417
417
|
* string, a boolean or a finite number.
|
|
418
418
|
* @example
|
|
@@ -426,7 +426,7 @@ export declare const filter: {
|
|
|
426
426
|
* match a missing or `null` field.
|
|
427
427
|
*
|
|
428
428
|
* @param field - Query field path, e.g. `state.status`.
|
|
429
|
-
* @returns `{ op: '
|
|
429
|
+
* @returns `{ op: 'is-empty', field }`.
|
|
430
430
|
* @throws TypeError If `field` is not a valid query field path.
|
|
431
431
|
* @example
|
|
432
432
|
* ```typescript
|
|
@@ -439,7 +439,7 @@ export declare const filter: {
|
|
|
439
439
|
* strings do not match.
|
|
440
440
|
*
|
|
441
441
|
* @param field - Query field path, e.g. `state.status`.
|
|
442
|
-
* @returns `{ op: '
|
|
442
|
+
* @returns `{ op: 'is-empty-string', field }`.
|
|
443
443
|
* @throws TypeError If `field` is not a valid query field path.
|
|
444
444
|
* @example
|
|
445
445
|
* ```typescript
|
|
@@ -452,7 +452,7 @@ export declare const filter: {
|
|
|
452
452
|
* `""`.
|
|
453
453
|
*
|
|
454
454
|
* @param field - Query field path, e.g. `state.status`.
|
|
455
|
-
* @returns `{ op: '
|
|
455
|
+
* @returns `{ op: 'is-not-empty-string', field }`.
|
|
456
456
|
* @throws TypeError If `field` is not a valid query field path.
|
|
457
457
|
* @example
|
|
458
458
|
* ```typescript
|
|
@@ -465,7 +465,7 @@ export declare const filter: {
|
|
|
465
465
|
* backend's null semantics.
|
|
466
466
|
*
|
|
467
467
|
* @param field - Query field path, e.g. `state.status`.
|
|
468
|
-
* @returns `{ op: '
|
|
468
|
+
* @returns `{ op: 'is-null', field }`.
|
|
469
469
|
* @throws TypeError If `field` is not a valid query field path.
|
|
470
470
|
* @example
|
|
471
471
|
* ```typescript
|
|
@@ -478,7 +478,7 @@ export declare const filter: {
|
|
|
478
478
|
* backend's null semantics.
|
|
479
479
|
*
|
|
480
480
|
* @param field - Query field path, e.g. `state.status`.
|
|
481
|
-
* @returns `{ op: '
|
|
481
|
+
* @returns `{ op: 'is-not-null', field }`.
|
|
482
482
|
* @throws TypeError If `field` is not a valid query field path.
|
|
483
483
|
* @example
|
|
484
484
|
* ```typescript
|
|
@@ -491,7 +491,7 @@ export declare const filter: {
|
|
|
491
491
|
* value.
|
|
492
492
|
*
|
|
493
493
|
* @param field - Query field path, e.g. `state.status`.
|
|
494
|
-
* @returns `{ op: '
|
|
494
|
+
* @returns `{ op: 'exists', field }`.
|
|
495
495
|
* @throws TypeError If `field` is not a valid query field path.
|
|
496
496
|
* @example
|
|
497
497
|
* ```typescript
|
|
@@ -503,7 +503,7 @@ export declare const filter: {
|
|
|
503
503
|
* Matches records where `field` is missing.
|
|
504
504
|
*
|
|
505
505
|
* @param field - Query field path, e.g. `state.status`.
|
|
506
|
-
* @returns `{ op: '
|
|
506
|
+
* @returns `{ op: 'not-exists', field }`.
|
|
507
507
|
* @throws TypeError If `field` is not a valid query field path.
|
|
508
508
|
* @example
|
|
509
509
|
* ```typescript
|
|
@@ -517,7 +517,7 @@ export declare const filter: {
|
|
|
517
517
|
* not allowed inside `elementMatch`.
|
|
518
518
|
*
|
|
519
519
|
* @param state - `ACTIVE`, `DELETED` or `ALL`.
|
|
520
|
-
* @returns `{ op: '
|
|
520
|
+
* @returns `{ op: 'deletion', state }`.
|
|
521
521
|
* @throws TypeError If `state` is not a {@link DeletionState} member.
|
|
522
522
|
* @example
|
|
523
523
|
* ```typescript
|
|
@@ -531,7 +531,7 @@ export declare const filter: {
|
|
|
531
531
|
*
|
|
532
532
|
* @param field - Query field path of the array, e.g. `state.items`.
|
|
533
533
|
* @param predicate - Element-scoped filter expression.
|
|
534
|
-
* @returns `{ op: '
|
|
534
|
+
* @returns `{ op: 'element-match', field, predicate }`.
|
|
535
535
|
* A `SEARCH` inside it must name the fields it searches, relative to the
|
|
536
536
|
* element (Wow 9.2 and later, where the descriptor lists
|
|
537
537
|
* `elements[].search`); a model-wide `SEARCH` is a root filter.
|
|
@@ -560,7 +560,7 @@ export declare const filter: {
|
|
|
560
560
|
* @param query - Search text.
|
|
561
561
|
* @param options - Optional `fields` (defaults to `[]`, the backend's default
|
|
562
562
|
* search fields) and `mode` (defaults to `SearchMode.TERMS`).
|
|
563
|
-
* @returns `{ op: '
|
|
563
|
+
* @returns `{ op: 'search', query, mode, fields }`.
|
|
564
564
|
* @throws TypeError If `query` is not a string or is blank, `options` is
|
|
565
565
|
* given but is `null`, an array or not an object, `mode` is not a
|
|
566
566
|
* {@link SearchMode} member, or any of `fields` is not a valid query field
|
|
@@ -582,7 +582,7 @@ export declare const filter: {
|
|
|
582
582
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
583
583
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
584
584
|
* `TimeUnit.MILLISECONDS`.
|
|
585
|
-
* @returns `{ op: '
|
|
585
|
+
* @returns `{ op: 'today', field, timeUnit }`, plus `zoneId` and
|
|
586
586
|
* `datePattern` when set.
|
|
587
587
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
588
588
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -603,7 +603,7 @@ export declare const filter: {
|
|
|
603
603
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
604
604
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
605
605
|
* `TimeUnit.MILLISECONDS`.
|
|
606
|
-
* @returns `{ op: '
|
|
606
|
+
* @returns `{ op: 'before-today', field, time, timeUnit }`, plus `zoneId`
|
|
607
607
|
* and `datePattern` when set.
|
|
608
608
|
* @throws TypeError If `time` is not a string in one of the formats above,
|
|
609
609
|
* `field` is not a valid query field path, `zoneId` is blank or an invalid UTC offset,
|
|
@@ -623,7 +623,7 @@ export declare const filter: {
|
|
|
623
623
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
624
624
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
625
625
|
* `TimeUnit.MILLISECONDS`.
|
|
626
|
-
* @returns `{ op: '
|
|
626
|
+
* @returns `{ op: 'tomorrow', field, timeUnit }`, plus `zoneId` and
|
|
627
627
|
* `datePattern` when set.
|
|
628
628
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
629
629
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -642,7 +642,7 @@ export declare const filter: {
|
|
|
642
642
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
643
643
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
644
644
|
* `TimeUnit.MILLISECONDS`.
|
|
645
|
-
* @returns `{ op: '
|
|
645
|
+
* @returns `{ op: 'this-week', field, timeUnit }`, plus `zoneId` and
|
|
646
646
|
* `datePattern` when set.
|
|
647
647
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
648
648
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -661,7 +661,7 @@ export declare const filter: {
|
|
|
661
661
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
662
662
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
663
663
|
* `TimeUnit.MILLISECONDS`.
|
|
664
|
-
* @returns `{ op: '
|
|
664
|
+
* @returns `{ op: 'next-week', field, timeUnit }`, plus `zoneId` and
|
|
665
665
|
* `datePattern` when set.
|
|
666
666
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
667
667
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -680,7 +680,7 @@ export declare const filter: {
|
|
|
680
680
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
681
681
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
682
682
|
* `TimeUnit.MILLISECONDS`.
|
|
683
|
-
* @returns `{ op: '
|
|
683
|
+
* @returns `{ op: 'last-week', field, timeUnit }`, plus `zoneId` and
|
|
684
684
|
* `datePattern` when set.
|
|
685
685
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
686
686
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -699,7 +699,7 @@ export declare const filter: {
|
|
|
699
699
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
700
700
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
701
701
|
* `TimeUnit.MILLISECONDS`.
|
|
702
|
-
* @returns `{ op: '
|
|
702
|
+
* @returns `{ op: 'this-month', field, timeUnit }`, plus `zoneId` and
|
|
703
703
|
* `datePattern` when set.
|
|
704
704
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
705
705
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -718,7 +718,7 @@ export declare const filter: {
|
|
|
718
718
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
719
719
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
720
720
|
* `TimeUnit.MILLISECONDS`.
|
|
721
|
-
* @returns `{ op: '
|
|
721
|
+
* @returns `{ op: 'last-month', field, timeUnit }`, plus `zoneId` and
|
|
722
722
|
* `datePattern` when set.
|
|
723
723
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
724
724
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -737,7 +737,7 @@ export declare const filter: {
|
|
|
737
737
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
738
738
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
739
739
|
* `TimeUnit.MILLISECONDS`.
|
|
740
|
-
* @returns `{ op: '
|
|
740
|
+
* @returns `{ op: 'yesterday', field, timeUnit }`, plus `zoneId` and
|
|
741
741
|
* `datePattern` when set.
|
|
742
742
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
743
743
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -756,7 +756,7 @@ export declare const filter: {
|
|
|
756
756
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
757
757
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
758
758
|
* `TimeUnit.MILLISECONDS`.
|
|
759
|
-
* @returns `{ op: '
|
|
759
|
+
* @returns `{ op: 'next-month', field, timeUnit }`, plus `zoneId` and
|
|
760
760
|
* `datePattern` when set.
|
|
761
761
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
762
762
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -775,7 +775,7 @@ export declare const filter: {
|
|
|
775
775
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
776
776
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
777
777
|
* `TimeUnit.MILLISECONDS`.
|
|
778
|
-
* @returns `{ op: '
|
|
778
|
+
* @returns `{ op: 'last-year', field, timeUnit }`, plus `zoneId` and
|
|
779
779
|
* `datePattern` when set.
|
|
780
780
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
781
781
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -794,7 +794,7 @@ export declare const filter: {
|
|
|
794
794
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
795
795
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
796
796
|
* `TimeUnit.MILLISECONDS`.
|
|
797
|
-
* @returns `{ op: '
|
|
797
|
+
* @returns `{ op: 'this-year', field, timeUnit }`, plus `zoneId` and
|
|
798
798
|
* `datePattern` when set.
|
|
799
799
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
800
800
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -813,7 +813,7 @@ export declare const filter: {
|
|
|
813
813
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
814
814
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
815
815
|
* `TimeUnit.MILLISECONDS`.
|
|
816
|
-
* @returns `{ op: '
|
|
816
|
+
* @returns `{ op: 'next-year', field, timeUnit }`, plus `zoneId` and
|
|
817
817
|
* `datePattern` when set.
|
|
818
818
|
* @throws TypeError If `field` is not a valid query field path, `zoneId` is blank or an
|
|
819
819
|
* invalid UTC offset, `datePattern` is blank or not a valid
|
|
@@ -834,7 +834,7 @@ export declare const filter: {
|
|
|
834
834
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
835
835
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
836
836
|
* `TimeUnit.MILLISECONDS`.
|
|
837
|
-
* @returns `{ op: '
|
|
837
|
+
* @returns `{ op: 'recent-days', field, days, timeUnit }`, plus `zoneId` and
|
|
838
838
|
* `datePattern` when set.
|
|
839
839
|
* @throws TypeError If `days` is not an integer from 1 to 2147483647,
|
|
840
840
|
* `field` is not a valid query field path, `zoneId` is blank or an invalid UTC offset,
|
|
@@ -856,7 +856,7 @@ export declare const filter: {
|
|
|
856
856
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
857
857
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
858
858
|
* `TimeUnit.MILLISECONDS`.
|
|
859
|
-
* @returns `{ op: '
|
|
859
|
+
* @returns `{ op: 'earlier-days', field, days, timeUnit }`, plus `zoneId` and
|
|
860
860
|
* `datePattern` when set.
|
|
861
861
|
* @throws TypeError If `days` is not an integer from 1 to 2147483647,
|
|
862
862
|
* `field` is not a valid query field path, `zoneId` is blank or an invalid UTC offset,
|
|
@@ -885,7 +885,7 @@ export declare const filter: {
|
|
|
885
885
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
886
886
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
887
887
|
* `TimeUnit.MILLISECONDS`.
|
|
888
|
-
* @returns `{ op: '
|
|
888
|
+
* @returns `{ op: 'before-now', field, offset, timeUnit }`, plus `zoneId` and
|
|
889
889
|
* `datePattern` when set.
|
|
890
890
|
* @throws TypeError If `offset` is not an ISO-8601 duration in that
|
|
891
891
|
* grammar, `field` is not a valid query field path, `zoneId` is blank or
|
|
@@ -915,7 +915,7 @@ export declare const filter: {
|
|
|
915
915
|
* @param options - Optional `zoneId`, `datePattern` and `timeUnit`; see
|
|
916
916
|
* {@link RelativeTimeFilterOptions}. `timeUnit` defaults to
|
|
917
917
|
* `TimeUnit.MILLISECONDS`.
|
|
918
|
-
* @returns `{ op: '
|
|
918
|
+
* @returns `{ op: 'after-now', field, offset, timeUnit }`, plus `zoneId` and
|
|
919
919
|
* `datePattern` when set.
|
|
920
920
|
* @throws TypeError If `offset` is not an ISO-8601 duration in that
|
|
921
921
|
* grammar, `field` is not a valid query field path, `zoneId` is blank or
|
|
@@ -930,7 +930,7 @@ export declare const filter: {
|
|
|
930
930
|
afterNow<FIELDS extends string>(field: FIELDS, offset?: string, options?: RelativeTimeFilterOptions): NowFilter<FIELDS>;
|
|
931
931
|
/**
|
|
932
932
|
* Compares a computed expression with a number, such as the hours from
|
|
933
|
-
* `paidAt` to `shippedAt`. `{ op: '
|
|
933
|
+
* `paidAt` to `shippedAt`. `{ op: 'expression', expression, comparison,
|
|
934
934
|
* value }`.
|
|
935
935
|
*
|
|
936
936
|
* The expression is evaluated per record, so this is an expensive
|