quetch 0.11.2 → 0.12.0
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/dist/middlewares/fetchExternal.js.map +1 -1
- package/dist/tools/filterItem.js +99 -23
- package/dist/tools/filterItem.js.map +1 -1
- package/dist/types/FilterString.d.ts +3 -0
- package/dist/types/FilterStringIntersect.d.ts +3 -0
- package/dist/types/FilterStringMatch.d.ts +2 -2
- package/dist/types/Locale.d.ts +1 -0
- package/dist/types/Locale.js +2 -0
- package/dist/types/Locale.js.map +1 -0
- package/dist/types.d.ts +1 -0
- package/doc/README.md +86 -71
- package/doc/classes/RequestError.md +5 -5
- package/doc/interfaces/CustomFetch.md +1 -1
- package/lib/middlewares/fetchExternal.ts +1 -1
- package/lib/tools/filterItem.test.ts +81 -37
- package/lib/tools/filterItem.ts +184 -29
- package/lib/types/FilterString.ts +3 -0
- package/lib/types/FilterStringIntersect.ts +3 -0
- package/lib/types/FilterStringMatch.ts +2 -2
- package/lib/types/Locale.ts +1 -0
- package/lib/types.ts +1 -0
- package/package.json +1 -1
package/doc/README.md
CHANGED
|
@@ -44,6 +44,7 @@ quetch
|
|
|
44
44
|
- [InjectCustomFields](README.md#injectcustomfields)
|
|
45
45
|
- [Item](README.md#item)
|
|
46
46
|
- [Key](README.md#key)
|
|
47
|
+
- [Locale](README.md#locale)
|
|
47
48
|
- [Mutable](README.md#mutable)
|
|
48
49
|
- [NextHandler](README.md#nexthandler)
|
|
49
50
|
- [Order](README.md#order)
|
|
@@ -103,7 +104,7 @@ Aggregation function.
|
|
|
103
104
|
|
|
104
105
|
#### Defined in
|
|
105
106
|
|
|
106
|
-
[lib/types/AggregateFunction.ts:4](https://github.com/nevoland/quetch/blob/
|
|
107
|
+
[lib/types/AggregateFunction.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/AggregateFunction.ts#L4)
|
|
107
108
|
|
|
108
109
|
___
|
|
109
110
|
|
|
@@ -113,7 +114,7 @@ ___
|
|
|
113
114
|
|
|
114
115
|
#### Defined in
|
|
115
116
|
|
|
116
|
-
[lib/types/AggregateFunctionOperator.ts:3](https://github.com/nevoland/quetch/blob/
|
|
117
|
+
[lib/types/AggregateFunctionOperator.ts:3](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/AggregateFunctionOperator.ts#L3)
|
|
117
118
|
|
|
118
119
|
___
|
|
119
120
|
|
|
@@ -123,7 +124,7 @@ ___
|
|
|
123
124
|
|
|
124
125
|
#### Defined in
|
|
125
126
|
|
|
126
|
-
[lib/types/Any.ts:1](https://github.com/nevoland/quetch/blob/
|
|
127
|
+
[lib/types/Any.ts:1](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Any.ts#L1)
|
|
127
128
|
|
|
128
129
|
___
|
|
129
130
|
|
|
@@ -139,7 +140,7 @@ ___
|
|
|
139
140
|
|
|
140
141
|
#### Defined in
|
|
141
142
|
|
|
142
|
-
[lib/types/Context.ts:1](https://github.com/nevoland/quetch/blob/
|
|
143
|
+
[lib/types/Context.ts:1](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Context.ts#L1)
|
|
143
144
|
|
|
144
145
|
___
|
|
145
146
|
|
|
@@ -155,7 +156,7 @@ ___
|
|
|
155
156
|
|
|
156
157
|
#### Defined in
|
|
157
158
|
|
|
158
|
-
[lib/types/CustomFieldAggregateMap.ts:3](https://github.com/nevoland/quetch/blob/
|
|
159
|
+
[lib/types/CustomFieldAggregateMap.ts:3](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/CustomFieldAggregateMap.ts#L3)
|
|
159
160
|
|
|
160
161
|
___
|
|
161
162
|
|
|
@@ -171,7 +172,7 @@ ___
|
|
|
171
172
|
|
|
172
173
|
#### Defined in
|
|
173
174
|
|
|
174
|
-
[lib/types/CustomFieldMap.ts:3](https://github.com/nevoland/quetch/blob/
|
|
175
|
+
[lib/types/CustomFieldMap.ts:3](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/CustomFieldMap.ts#L3)
|
|
175
176
|
|
|
176
177
|
___
|
|
177
178
|
|
|
@@ -187,7 +188,7 @@ ___
|
|
|
187
188
|
|
|
188
189
|
#### Defined in
|
|
189
190
|
|
|
190
|
-
[lib/types/FieldFunction.ts:4](https://github.com/nevoland/quetch/blob/
|
|
191
|
+
[lib/types/FieldFunction.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FieldFunction.ts#L4)
|
|
191
192
|
|
|
192
193
|
___
|
|
193
194
|
|
|
@@ -212,7 +213,7 @@ Applies a custom field transform function.
|
|
|
212
213
|
|
|
213
214
|
#### Defined in
|
|
214
215
|
|
|
215
|
-
[lib/types/FieldFunctionCustom.ts:4](https://github.com/nevoland/quetch/blob/
|
|
216
|
+
[lib/types/FieldFunctionCustom.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FieldFunctionCustom.ts#L4)
|
|
216
217
|
|
|
217
218
|
___
|
|
218
219
|
|
|
@@ -238,7 +239,7 @@ Formats the date found in a given field, which can be an ISO string date or a ti
|
|
|
238
239
|
|
|
239
240
|
#### Defined in
|
|
240
241
|
|
|
241
|
-
[lib/types/FieldFunctionFormatDate.ts:6](https://github.com/nevoland/quetch/blob/
|
|
242
|
+
[lib/types/FieldFunctionFormatDate.ts:6](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FieldFunctionFormatDate.ts#L6)
|
|
242
243
|
|
|
243
244
|
___
|
|
244
245
|
|
|
@@ -256,7 +257,7 @@ Return types of custom field functions.
|
|
|
256
257
|
|
|
257
258
|
#### Defined in
|
|
258
259
|
|
|
259
|
-
[lib/types/FieldFunctionReturn.ts:4](https://github.com/nevoland/quetch/blob/
|
|
260
|
+
[lib/types/FieldFunctionReturn.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FieldFunctionReturn.ts#L4)
|
|
260
261
|
|
|
261
262
|
___
|
|
262
263
|
|
|
@@ -274,7 +275,7 @@ Describes a predicate for filtering items.
|
|
|
274
275
|
|
|
275
276
|
#### Defined in
|
|
276
277
|
|
|
277
|
-
[lib/types/Filter.ts:15](https://github.com/nevoland/quetch/blob/
|
|
278
|
+
[lib/types/Filter.ts:15](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Filter.ts#L15)
|
|
278
279
|
|
|
279
280
|
___
|
|
280
281
|
|
|
@@ -301,7 +302,7 @@ Checks if a given array field matches a given array value according to a given o
|
|
|
301
302
|
|
|
302
303
|
#### Defined in
|
|
303
304
|
|
|
304
|
-
[lib/types/FilterArray.ts:7](https://github.com/nevoland/quetch/blob/
|
|
305
|
+
[lib/types/FilterArray.ts:7](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterArray.ts#L7)
|
|
305
306
|
|
|
306
307
|
___
|
|
307
308
|
|
|
@@ -327,7 +328,7 @@ Checks if a given boolean field is `true` or `false`.
|
|
|
327
328
|
|
|
328
329
|
#### Defined in
|
|
329
330
|
|
|
330
|
-
[lib/types/FilterBoolean.ts:6](https://github.com/nevoland/quetch/blob/
|
|
331
|
+
[lib/types/FilterBoolean.ts:6](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterBoolean.ts#L6)
|
|
331
332
|
|
|
332
333
|
___
|
|
333
334
|
|
|
@@ -355,7 +356,7 @@ If `deep` is `true`, also captures all the descendants.
|
|
|
355
356
|
|
|
356
357
|
#### Defined in
|
|
357
358
|
|
|
358
|
-
[lib/types/FilterChildren.ts:10](https://github.com/nevoland/quetch/blob/
|
|
359
|
+
[lib/types/FilterChildren.ts:10](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterChildren.ts#L10)
|
|
359
360
|
|
|
360
361
|
___
|
|
361
362
|
|
|
@@ -380,7 +381,7 @@ Custom filter where `value(item)` returns `true` for matching items.
|
|
|
380
381
|
|
|
381
382
|
#### Defined in
|
|
382
383
|
|
|
383
|
-
[lib/types/FilterCustom.ts:4](https://github.com/nevoland/quetch/blob/
|
|
384
|
+
[lib/types/FilterCustom.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterCustom.ts#L4)
|
|
384
385
|
|
|
385
386
|
___
|
|
386
387
|
|
|
@@ -405,7 +406,7 @@ Checks if a given field exists.
|
|
|
405
406
|
|
|
406
407
|
#### Defined in
|
|
407
408
|
|
|
408
|
-
[lib/types/FilterField.ts:4](https://github.com/nevoland/quetch/blob/
|
|
409
|
+
[lib/types/FilterField.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterField.ts#L4)
|
|
409
410
|
|
|
410
411
|
___
|
|
411
412
|
|
|
@@ -423,7 +424,7 @@ Joins a list of filters with a specific boolean operator.
|
|
|
423
424
|
|
|
424
425
|
#### Defined in
|
|
425
426
|
|
|
426
|
-
[lib/types/FilterGroup.ts:6](https://github.com/nevoland/quetch/blob/
|
|
427
|
+
[lib/types/FilterGroup.ts:6](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterGroup.ts#L6)
|
|
427
428
|
|
|
428
429
|
___
|
|
429
430
|
|
|
@@ -442,7 +443,7 @@ Returns object type with field extending the provided `P` type.
|
|
|
442
443
|
|
|
443
444
|
#### Defined in
|
|
444
445
|
|
|
445
|
-
[lib/types/FilterKeys.ts:4](https://github.com/nevoland/quetch/blob/
|
|
446
|
+
[lib/types/FilterKeys.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterKeys.ts#L4)
|
|
446
447
|
|
|
447
448
|
___
|
|
448
449
|
|
|
@@ -468,7 +469,7 @@ Checks if a given number field matches a given number value according to a given
|
|
|
468
469
|
|
|
469
470
|
#### Defined in
|
|
470
471
|
|
|
471
|
-
[lib/types/FilterNumber.ts:6](https://github.com/nevoland/quetch/blob/
|
|
472
|
+
[lib/types/FilterNumber.ts:6](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterNumber.ts#L6)
|
|
472
473
|
|
|
473
474
|
___
|
|
474
475
|
|
|
@@ -478,7 +479,7 @@ ___
|
|
|
478
479
|
|
|
479
480
|
#### Defined in
|
|
480
481
|
|
|
481
|
-
[lib/types/FilterOperator.ts:3](https://github.com/nevoland/quetch/blob/
|
|
482
|
+
[lib/types/FilterOperator.ts:3](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterOperator.ts#L3)
|
|
482
483
|
|
|
483
484
|
___
|
|
484
485
|
|
|
@@ -499,12 +500,14 @@ Checks if a given string field matches a given string value according to a given
|
|
|
499
500
|
| Name | Type |
|
|
500
501
|
| :------ | :------ |
|
|
501
502
|
| `field` | [`FilterKeys`](README.md#filterkeys)<`T`, `string`\> |
|
|
503
|
+
| `locale?` | [`Locale`](README.md#locale) |
|
|
502
504
|
| `operator` | ``"equal"`` \| ``"notEqual"`` \| ``"startWith"`` \| ``"endWith"`` \| ``"include"`` \| ``"greaterThan"`` \| ``"greaterThanOrEqual"`` \| ``"lowerThan"`` \| ``"lowerThanOrEqual"`` |
|
|
505
|
+
| `options?` | `Intl.CollatorOptions` |
|
|
503
506
|
| `value` | `string` |
|
|
504
507
|
|
|
505
508
|
#### Defined in
|
|
506
509
|
|
|
507
|
-
[lib/types/FilterString.ts:
|
|
510
|
+
[lib/types/FilterString.ts:7](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterString.ts#L7)
|
|
508
511
|
|
|
509
512
|
___
|
|
510
513
|
|
|
@@ -525,12 +528,14 @@ Checks if a given string field has any of the provided values.
|
|
|
525
528
|
| Name | Type |
|
|
526
529
|
| :------ | :------ |
|
|
527
530
|
| `field` | [`FilterKeys`](README.md#filterkeys)<`T`, `string`\> |
|
|
531
|
+
| `locale?` | [`Locale`](README.md#locale) |
|
|
528
532
|
| `operator` | ``"intersect"`` |
|
|
533
|
+
| `options?` | `Intl.CollatorOptions` |
|
|
529
534
|
| `value` | `string`[] |
|
|
530
535
|
|
|
531
536
|
#### Defined in
|
|
532
537
|
|
|
533
|
-
[lib/types/FilterStringIntersect.ts:
|
|
538
|
+
[lib/types/FilterStringIntersect.ts:7](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterStringIntersect.ts#L7)
|
|
534
539
|
|
|
535
540
|
___
|
|
536
541
|
|
|
@@ -554,13 +559,13 @@ Checks if a given string field matches a given regular expression.
|
|
|
554
559
|
| `field` | [`FilterKeys`](README.md#filterkeys)<`T`, `string`\> | - |
|
|
555
560
|
| `operator` | ``"match"`` | - |
|
|
556
561
|
| `options?` | { `dotAll?`: `boolean` ; `ignoreCase?`: `boolean` } | Regular expression options. |
|
|
557
|
-
| `options.dotAll?` | `boolean` |
|
|
558
|
-
| `options.ignoreCase?` | `boolean` |
|
|
562
|
+
| `options.dotAll?` | `boolean` | Allow `.` to match newlines. |
|
|
563
|
+
| `options.ignoreCase?` | `boolean` | Ignore casing differences if `true`. |
|
|
559
564
|
| `value` | `string` | Raw regular expression string. |
|
|
560
565
|
|
|
561
566
|
#### Defined in
|
|
562
567
|
|
|
563
|
-
[lib/types/FilterStringMatch.ts:8](https://github.com/nevoland/quetch/blob/
|
|
568
|
+
[lib/types/FilterStringMatch.ts:8](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/FilterStringMatch.ts#L8)
|
|
564
569
|
|
|
565
570
|
___
|
|
566
571
|
|
|
@@ -580,7 +585,7 @@ Returns the type of the property at the specified `K` key.
|
|
|
580
585
|
|
|
581
586
|
#### Defined in
|
|
582
587
|
|
|
583
|
-
[lib/types/Get.ts:4](https://github.com/nevoland/quetch/blob/
|
|
588
|
+
[lib/types/Get.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Get.ts#L4)
|
|
584
589
|
|
|
585
590
|
___
|
|
586
591
|
|
|
@@ -598,7 +603,7 @@ Specifies how items should be grouped.
|
|
|
598
603
|
|
|
599
604
|
#### Defined in
|
|
600
605
|
|
|
601
|
-
[lib/types/Group.ts:4](https://github.com/nevoland/quetch/blob/
|
|
606
|
+
[lib/types/Group.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Group.ts#L4)
|
|
602
607
|
|
|
603
608
|
___
|
|
604
609
|
|
|
@@ -634,7 +639,7 @@ Handles an `input` query and returns an `output` promise, eventually using the `
|
|
|
634
639
|
|
|
635
640
|
#### Defined in
|
|
636
641
|
|
|
637
|
-
[lib/types/Handler.ts:6](https://github.com/nevoland/quetch/blob/
|
|
642
|
+
[lib/types/Handler.ts:6](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Handler.ts#L6)
|
|
638
643
|
|
|
639
644
|
___
|
|
640
645
|
|
|
@@ -650,7 +655,7 @@ ___
|
|
|
650
655
|
|
|
651
656
|
#### Defined in
|
|
652
657
|
|
|
653
|
-
[lib/types/Immutable.ts:1](https://github.com/nevoland/quetch/blob/
|
|
658
|
+
[lib/types/Immutable.ts:1](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Immutable.ts#L1)
|
|
654
659
|
|
|
655
660
|
___
|
|
656
661
|
|
|
@@ -669,7 +674,7 @@ Injects the custom fields into the entity type.
|
|
|
669
674
|
|
|
670
675
|
#### Defined in
|
|
671
676
|
|
|
672
|
-
[lib/types/InjectCustomFields.ts:8](https://github.com/nevoland/quetch/blob/
|
|
677
|
+
[lib/types/InjectCustomFields.ts:8](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/InjectCustomFields.ts#L8)
|
|
673
678
|
|
|
674
679
|
___
|
|
675
680
|
|
|
@@ -688,7 +693,7 @@ Returns the inferred item type of an array, or an alternative type if it is some
|
|
|
688
693
|
|
|
689
694
|
#### Defined in
|
|
690
695
|
|
|
691
|
-
[lib/types/Item.ts:4](https://github.com/nevoland/quetch/blob/
|
|
696
|
+
[lib/types/Item.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Item.ts#L4)
|
|
692
697
|
|
|
693
698
|
___
|
|
694
699
|
|
|
@@ -698,7 +703,17 @@ ___
|
|
|
698
703
|
|
|
699
704
|
#### Defined in
|
|
700
705
|
|
|
701
|
-
[lib/types/Key.ts:1](https://github.com/nevoland/quetch/blob/
|
|
706
|
+
[lib/types/Key.ts:1](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Key.ts#L1)
|
|
707
|
+
|
|
708
|
+
___
|
|
709
|
+
|
|
710
|
+
### Locale
|
|
711
|
+
|
|
712
|
+
Ƭ **Locale**: `string` \| `string`[]
|
|
713
|
+
|
|
714
|
+
#### Defined in
|
|
715
|
+
|
|
716
|
+
[lib/types/Locale.ts:1](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Locale.ts#L1)
|
|
702
717
|
|
|
703
718
|
___
|
|
704
719
|
|
|
@@ -714,7 +729,7 @@ ___
|
|
|
714
729
|
|
|
715
730
|
#### Defined in
|
|
716
731
|
|
|
717
|
-
[lib/types/Mutable.ts:1](https://github.com/nevoland/quetch/blob/
|
|
732
|
+
[lib/types/Mutable.ts:1](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Mutable.ts#L1)
|
|
718
733
|
|
|
719
734
|
___
|
|
720
735
|
|
|
@@ -747,7 +762,7 @@ Handles an `input` query and returns an `output` promise.
|
|
|
747
762
|
|
|
748
763
|
#### Defined in
|
|
749
764
|
|
|
750
|
-
[lib/types/NextHandler.ts:4](https://github.com/nevoland/quetch/blob/
|
|
765
|
+
[lib/types/NextHandler.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/NextHandler.ts#L4)
|
|
751
766
|
|
|
752
767
|
___
|
|
753
768
|
|
|
@@ -765,7 +780,7 @@ Order item.
|
|
|
765
780
|
|
|
766
781
|
#### Defined in
|
|
767
782
|
|
|
768
|
-
[lib/types/Order.ts:4](https://github.com/nevoland/quetch/blob/
|
|
783
|
+
[lib/types/Order.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Order.ts#L4)
|
|
769
784
|
|
|
770
785
|
___
|
|
771
786
|
|
|
@@ -775,7 +790,7 @@ ___
|
|
|
775
790
|
|
|
776
791
|
#### Defined in
|
|
777
792
|
|
|
778
|
-
[lib/types/Parameters.ts:1](https://github.com/nevoland/quetch/blob/
|
|
793
|
+
[lib/types/Parameters.ts:1](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Parameters.ts#L1)
|
|
779
794
|
|
|
780
795
|
___
|
|
781
796
|
|
|
@@ -793,7 +808,7 @@ Query that fetches or mutates an entity.
|
|
|
793
808
|
|
|
794
809
|
#### Defined in
|
|
795
810
|
|
|
796
|
-
[lib/types/Query.ts:14](https://github.com/nevoland/quetch/blob/
|
|
811
|
+
[lib/types/Query.ts:14](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Query.ts#L14)
|
|
797
812
|
|
|
798
813
|
___
|
|
799
814
|
|
|
@@ -822,7 +837,7 @@ Query for computing an aggregated value.
|
|
|
822
837
|
|
|
823
838
|
#### Defined in
|
|
824
839
|
|
|
825
|
-
[lib/types/QueryAggregate.ts:10](https://github.com/nevoland/quetch/blob/
|
|
840
|
+
[lib/types/QueryAggregate.ts:10](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryAggregate.ts#L10)
|
|
826
841
|
|
|
827
842
|
___
|
|
828
843
|
|
|
@@ -851,7 +866,7 @@ Query for creating an item.
|
|
|
851
866
|
|
|
852
867
|
#### Defined in
|
|
853
868
|
|
|
854
|
-
[lib/types/QueryCreate.ts:8](https://github.com/nevoland/quetch/blob/
|
|
869
|
+
[lib/types/QueryCreate.ts:8](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryCreate.ts#L8)
|
|
855
870
|
|
|
856
871
|
___
|
|
857
872
|
|
|
@@ -880,7 +895,7 @@ Query for creating multiple items.
|
|
|
880
895
|
|
|
881
896
|
#### Defined in
|
|
882
897
|
|
|
883
|
-
[lib/types/QueryCreateMultiple.ts:8](https://github.com/nevoland/quetch/blob/
|
|
898
|
+
[lib/types/QueryCreateMultiple.ts:8](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryCreateMultiple.ts#L8)
|
|
884
899
|
|
|
885
900
|
___
|
|
886
901
|
|
|
@@ -909,7 +924,7 @@ Query for deleting an item.
|
|
|
909
924
|
|
|
910
925
|
#### Defined in
|
|
911
926
|
|
|
912
|
-
[lib/types/QueryDelete.ts:9](https://github.com/nevoland/quetch/blob/
|
|
927
|
+
[lib/types/QueryDelete.ts:9](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryDelete.ts#L9)
|
|
913
928
|
|
|
914
929
|
___
|
|
915
930
|
|
|
@@ -938,7 +953,7 @@ Query for deleting multiple items.
|
|
|
938
953
|
|
|
939
954
|
#### Defined in
|
|
940
955
|
|
|
941
|
-
[lib/types/QueryDeleteMultiple.ts:9](https://github.com/nevoland/quetch/blob/
|
|
956
|
+
[lib/types/QueryDeleteMultiple.ts:9](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryDeleteMultiple.ts#L9)
|
|
942
957
|
|
|
943
958
|
___
|
|
944
959
|
|
|
@@ -950,7 +965,7 @@ Available query methods.
|
|
|
950
965
|
|
|
951
966
|
#### Defined in
|
|
952
967
|
|
|
953
|
-
[lib/types/QueryMethod.ts:6](https://github.com/nevoland/quetch/blob/
|
|
968
|
+
[lib/types/QueryMethod.ts:6](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryMethod.ts#L6)
|
|
954
969
|
|
|
955
970
|
___
|
|
956
971
|
|
|
@@ -984,7 +999,7 @@ Query for reading a single item.
|
|
|
984
999
|
|
|
985
1000
|
#### Defined in
|
|
986
1001
|
|
|
987
|
-
[lib/types/QueryRead.ts:10](https://github.com/nevoland/quetch/blob/
|
|
1002
|
+
[lib/types/QueryRead.ts:10](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryRead.ts#L10)
|
|
988
1003
|
|
|
989
1004
|
___
|
|
990
1005
|
|
|
@@ -1018,7 +1033,7 @@ Query for getting a list of items.
|
|
|
1018
1033
|
|
|
1019
1034
|
#### Defined in
|
|
1020
1035
|
|
|
1021
|
-
[lib/types/QueryReadMultiple.ts:11](https://github.com/nevoland/quetch/blob/
|
|
1036
|
+
[lib/types/QueryReadMultiple.ts:11](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryReadMultiple.ts#L11)
|
|
1022
1037
|
|
|
1023
1038
|
___
|
|
1024
1039
|
|
|
@@ -1045,7 +1060,7 @@ Settings to use when doing a query.
|
|
|
1045
1060
|
|
|
1046
1061
|
#### Defined in
|
|
1047
1062
|
|
|
1048
|
-
[lib/types/QuerySettings.ts:8](https://github.com/nevoland/quetch/blob/
|
|
1063
|
+
[lib/types/QuerySettings.ts:8](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QuerySettings.ts#L8)
|
|
1049
1064
|
|
|
1050
1065
|
___
|
|
1051
1066
|
|
|
@@ -1078,7 +1093,7 @@ Query for updating an item.
|
|
|
1078
1093
|
|
|
1079
1094
|
#### Defined in
|
|
1080
1095
|
|
|
1081
|
-
[lib/types/QueryUpdate.ts:9](https://github.com/nevoland/quetch/blob/
|
|
1096
|
+
[lib/types/QueryUpdate.ts:9](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryUpdate.ts#L9)
|
|
1082
1097
|
|
|
1083
1098
|
___
|
|
1084
1099
|
|
|
@@ -1111,7 +1126,7 @@ Query for updating multiple items.
|
|
|
1111
1126
|
|
|
1112
1127
|
#### Defined in
|
|
1113
1128
|
|
|
1114
|
-
[lib/types/QueryUpdateMultiple.ts:10](https://github.com/nevoland/quetch/blob/
|
|
1129
|
+
[lib/types/QueryUpdateMultiple.ts:10](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/QueryUpdateMultiple.ts#L10)
|
|
1115
1130
|
|
|
1116
1131
|
___
|
|
1117
1132
|
|
|
@@ -1128,7 +1143,7 @@ ___
|
|
|
1128
1143
|
|
|
1129
1144
|
#### Defined in
|
|
1130
1145
|
|
|
1131
|
-
[lib/types/Result.ts:20](https://github.com/nevoland/quetch/blob/
|
|
1146
|
+
[lib/types/Result.ts:20](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Result.ts#L20)
|
|
1132
1147
|
|
|
1133
1148
|
___
|
|
1134
1149
|
|
|
@@ -1153,7 +1168,7 @@ ___
|
|
|
1153
1168
|
|
|
1154
1169
|
#### Defined in
|
|
1155
1170
|
|
|
1156
|
-
[lib/types/Store.ts:2](https://github.com/nevoland/quetch/blob/
|
|
1171
|
+
[lib/types/Store.ts:2](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/Store.ts#L2)
|
|
1157
1172
|
|
|
1158
1173
|
## Functions
|
|
1159
1174
|
|
|
@@ -1194,7 +1209,7 @@ If a query occurs twice, `mergeQuery(query, currentQuery)` is called and the out
|
|
|
1194
1209
|
|
|
1195
1210
|
#### Defined in
|
|
1196
1211
|
|
|
1197
|
-
[lib/middlewares/aggregate.ts:16](https://github.com/nevoland/quetch/blob/
|
|
1212
|
+
[lib/middlewares/aggregate.ts:16](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/aggregate.ts#L16)
|
|
1198
1213
|
|
|
1199
1214
|
___
|
|
1200
1215
|
|
|
@@ -1236,7 +1251,7 @@ const customFetch = combine(
|
|
|
1236
1251
|
|
|
1237
1252
|
#### Defined in
|
|
1238
1253
|
|
|
1239
|
-
[lib/middlewares/branch.ts:21](https://github.com/nevoland/quetch/blob/
|
|
1254
|
+
[lib/middlewares/branch.ts:21](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/branch.ts#L21)
|
|
1240
1255
|
|
|
1241
1256
|
___
|
|
1242
1257
|
|
|
@@ -1271,7 +1286,7 @@ ___
|
|
|
1271
1286
|
|
|
1272
1287
|
#### Defined in
|
|
1273
1288
|
|
|
1274
|
-
[lib/middlewares/cache.ts:8](https://github.com/nevoland/quetch/blob/
|
|
1289
|
+
[lib/middlewares/cache.ts:8](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/cache.ts#L8)
|
|
1275
1290
|
|
|
1276
1291
|
___
|
|
1277
1292
|
|
|
@@ -1344,7 +1359,7 @@ Handler that combines all provided handlers.
|
|
|
1344
1359
|
|
|
1345
1360
|
#### Defined in
|
|
1346
1361
|
|
|
1347
|
-
[lib/middlewares/combine.ts:801](https://github.com/nevoland/quetch/blob/
|
|
1362
|
+
[lib/middlewares/combine.ts:801](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/combine.ts#L801)
|
|
1348
1363
|
|
|
1349
1364
|
___
|
|
1350
1365
|
|
|
@@ -1366,7 +1381,7 @@ Uncallable handler used to terminate a sequence of handlers combined with `combi
|
|
|
1366
1381
|
|
|
1367
1382
|
#### Defined in
|
|
1368
1383
|
|
|
1369
|
-
[lib/types/NextHandler.ts:4](https://github.com/nevoland/quetch/blob/
|
|
1384
|
+
[lib/types/NextHandler.ts:4](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/NextHandler.ts#L4)
|
|
1370
1385
|
|
|
1371
1386
|
___
|
|
1372
1387
|
|
|
@@ -1429,7 +1444,7 @@ typeof `query`
|
|
|
1429
1444
|
|
|
1430
1445
|
#### Defined in
|
|
1431
1446
|
|
|
1432
|
-
[lib/tools/defineCheckQuery.ts:8](https://github.com/nevoland/quetch/blob/
|
|
1447
|
+
[lib/tools/defineCheckQuery.ts:8](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/defineCheckQuery.ts#L8)
|
|
1433
1448
|
|
|
1434
1449
|
___
|
|
1435
1450
|
|
|
@@ -1499,7 +1514,7 @@ A custom fetch function.
|
|
|
1499
1514
|
|
|
1500
1515
|
#### Defined in
|
|
1501
1516
|
|
|
1502
|
-
[lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/
|
|
1517
|
+
[lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/defineCustomFetch.ts#L11)
|
|
1503
1518
|
|
|
1504
1519
|
___
|
|
1505
1520
|
|
|
@@ -1562,7 +1577,7 @@ A curried generic fetch function.
|
|
|
1562
1577
|
|
|
1563
1578
|
#### Defined in
|
|
1564
1579
|
|
|
1565
|
-
[lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/
|
|
1580
|
+
[lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/defineGenericFetch.ts#L14)
|
|
1566
1581
|
|
|
1567
1582
|
___
|
|
1568
1583
|
|
|
@@ -1586,7 +1601,7 @@ Escaped regular expression
|
|
|
1586
1601
|
|
|
1587
1602
|
#### Defined in
|
|
1588
1603
|
|
|
1589
|
-
[lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/
|
|
1604
|
+
[lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/escapeRegex.ts#L7)
|
|
1590
1605
|
|
|
1591
1606
|
___
|
|
1592
1607
|
|
|
@@ -1610,7 +1625,7 @@ Handler that returns a promise that resolves to the response.
|
|
|
1610
1625
|
|
|
1611
1626
|
#### Defined in
|
|
1612
1627
|
|
|
1613
|
-
[lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/
|
|
1628
|
+
[lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/fetchExternal.ts#L12)
|
|
1614
1629
|
|
|
1615
1630
|
___
|
|
1616
1631
|
|
|
@@ -1634,7 +1649,7 @@ Promise that resolves to the response.
|
|
|
1634
1649
|
|
|
1635
1650
|
#### Defined in
|
|
1636
1651
|
|
|
1637
|
-
[lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/
|
|
1652
|
+
[lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/fetchLocal.ts#L9)
|
|
1638
1653
|
|
|
1639
1654
|
___
|
|
1640
1655
|
|
|
@@ -1663,7 +1678,7 @@ ___
|
|
|
1663
1678
|
|
|
1664
1679
|
#### Defined in
|
|
1665
1680
|
|
|
1666
|
-
[lib/tools/filterChildren.ts:5](https://github.com/nevoland/quetch/blob/
|
|
1681
|
+
[lib/tools/filterChildren.ts:5](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/filterChildren.ts#L5)
|
|
1667
1682
|
|
|
1668
1683
|
___
|
|
1669
1684
|
|
|
@@ -1689,7 +1704,7 @@ ___
|
|
|
1689
1704
|
|
|
1690
1705
|
#### Defined in
|
|
1691
1706
|
|
|
1692
|
-
[lib/tools/filterFromContext.ts:5](https://github.com/nevoland/quetch/blob/
|
|
1707
|
+
[lib/tools/filterFromContext.ts:5](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/filterFromContext.ts#L5)
|
|
1693
1708
|
|
|
1694
1709
|
___
|
|
1695
1710
|
|
|
@@ -1721,7 +1736,7 @@ Checks wether the provided `value` matches the `filter` or not.
|
|
|
1721
1736
|
|
|
1722
1737
|
#### Defined in
|
|
1723
1738
|
|
|
1724
|
-
[lib/tools/filterItem.ts:17](https://github.com/nevoland/quetch/blob/
|
|
1739
|
+
[lib/tools/filterItem.ts:17](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/filterItem.ts#L17)
|
|
1725
1740
|
|
|
1726
1741
|
___
|
|
1727
1742
|
|
|
@@ -1751,7 +1766,7 @@ ___
|
|
|
1751
1766
|
|
|
1752
1767
|
#### Defined in
|
|
1753
1768
|
|
|
1754
|
-
[lib/middlewares/identity.ts:3](https://github.com/nevoland/quetch/blob/
|
|
1769
|
+
[lib/middlewares/identity.ts:3](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/identity.ts#L3)
|
|
1755
1770
|
|
|
1756
1771
|
___
|
|
1757
1772
|
|
|
@@ -1781,7 +1796,7 @@ Whether the provided filter is a group filter or not.
|
|
|
1781
1796
|
|
|
1782
1797
|
#### Defined in
|
|
1783
1798
|
|
|
1784
|
-
[lib/tools/isFilterGroup.ts:9](https://github.com/nevoland/quetch/blob/
|
|
1799
|
+
[lib/tools/isFilterGroup.ts:9](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/isFilterGroup.ts#L9)
|
|
1785
1800
|
|
|
1786
1801
|
___
|
|
1787
1802
|
|
|
@@ -1814,7 +1829,7 @@ Query handler
|
|
|
1814
1829
|
|
|
1815
1830
|
#### Defined in
|
|
1816
1831
|
|
|
1817
|
-
[lib/middlewares/log.ts:13](https://github.com/nevoland/quetch/blob/
|
|
1832
|
+
[lib/middlewares/log.ts:13](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/log.ts#L13)
|
|
1818
1833
|
|
|
1819
1834
|
___
|
|
1820
1835
|
|
|
@@ -1845,7 +1860,7 @@ ___
|
|
|
1845
1860
|
|
|
1846
1861
|
#### Defined in
|
|
1847
1862
|
|
|
1848
|
-
[lib/tools/normalizeOrder.ts:3](https://github.com/nevoland/quetch/blob/
|
|
1863
|
+
[lib/tools/normalizeOrder.ts:3](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/normalizeOrder.ts#L3)
|
|
1849
1864
|
|
|
1850
1865
|
___
|
|
1851
1866
|
|
|
@@ -1872,7 +1887,7 @@ ___
|
|
|
1872
1887
|
|
|
1873
1888
|
#### Defined in
|
|
1874
1889
|
|
|
1875
|
-
[lib/tools/queryItemList.ts:41](https://github.com/nevoland/quetch/blob/
|
|
1890
|
+
[lib/tools/queryItemList.ts:41](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/queryItemList.ts#L41)
|
|
1876
1891
|
|
|
1877
1892
|
___
|
|
1878
1893
|
|
|
@@ -1901,7 +1916,7 @@ Handler
|
|
|
1901
1916
|
|
|
1902
1917
|
#### Defined in
|
|
1903
1918
|
|
|
1904
|
-
[lib/middlewares/retry.ts:15](https://github.com/nevoland/quetch/blob/
|
|
1919
|
+
[lib/middlewares/retry.ts:15](https://github.com/nevoland/quetch/blob/fbf3307/lib/middlewares/retry.ts#L15)
|
|
1905
1920
|
|
|
1906
1921
|
___
|
|
1907
1922
|
|
|
@@ -1932,4 +1947,4 @@ The same array sorted in place.
|
|
|
1932
1947
|
|
|
1933
1948
|
#### Defined in
|
|
1934
1949
|
|
|
1935
|
-
[lib/tools/sortItemList.ts:12](https://github.com/nevoland/quetch/blob/
|
|
1950
|
+
[lib/tools/sortItemList.ts:12](https://github.com/nevoland/quetch/blob/fbf3307/lib/tools/sortItemList.ts#L12)
|
|
@@ -45,7 +45,7 @@ Error.constructor
|
|
|
45
45
|
|
|
46
46
|
#### Defined in
|
|
47
47
|
|
|
48
|
-
[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/
|
|
48
|
+
[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L7)
|
|
49
49
|
|
|
50
50
|
## Properties
|
|
51
51
|
|
|
@@ -55,7 +55,7 @@ Error.constructor
|
|
|
55
55
|
|
|
56
56
|
#### Defined in
|
|
57
57
|
|
|
58
|
-
[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/
|
|
58
|
+
[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L10)
|
|
59
59
|
|
|
60
60
|
___
|
|
61
61
|
|
|
@@ -65,7 +65,7 @@ ___
|
|
|
65
65
|
|
|
66
66
|
#### Defined in
|
|
67
67
|
|
|
68
|
-
[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/
|
|
68
|
+
[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L11)
|
|
69
69
|
|
|
70
70
|
___
|
|
71
71
|
|
|
@@ -75,7 +75,7 @@ ___
|
|
|
75
75
|
|
|
76
76
|
#### Defined in
|
|
77
77
|
|
|
78
|
-
[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/
|
|
78
|
+
[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L12)
|
|
79
79
|
|
|
80
80
|
___
|
|
81
81
|
|
|
@@ -85,4 +85,4 @@ ___
|
|
|
85
85
|
|
|
86
86
|
#### Defined in
|
|
87
87
|
|
|
88
|
-
[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/
|
|
88
|
+
[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L9)
|