quetch 0.29.1 → 0.30.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.
Files changed (129) hide show
  1. package/dist/tools/intrinsicFilter.d.ts +1 -1
  2. package/dist/tools/intrinsicFilter.js +2 -2
  3. package/dist/tools/intrinsicFilter.js.map +1 -1
  4. package/dist/tools/queryItemList.js +2 -2
  5. package/dist/tools/queryItemList.js.map +1 -1
  6. package/dist/tools/testFilter.d.ts +1 -1
  7. package/dist/tools/testFilter.js +6 -9
  8. package/dist/tools/testFilter.js.map +1 -1
  9. package/dist/tools/transformerFilterChildren.d.ts +28 -0
  10. package/dist/tools/transformerFilterChildren.js +20 -0
  11. package/dist/tools/transformerFilterChildren.js.map +1 -0
  12. package/dist/tools.d.ts +1 -0
  13. package/dist/tools.js +1 -0
  14. package/dist/tools.js.map +1 -1
  15. package/dist/types/AggregateFunction.d.ts +1 -1
  16. package/dist/types/Context.d.ts +8 -0
  17. package/dist/types/FilterChildren.d.ts +1 -2
  18. package/dist/types/FilterGroup.d.ts +2 -2
  19. package/doc/README.md +1 -0
  20. package/doc/classes/RequestError.md +5 -5
  21. package/doc/functions/aggregate.md +1 -1
  22. package/doc/functions/branch.md +1 -1
  23. package/doc/functions/cache.md +1 -1
  24. package/doc/functions/combine.md +1 -1
  25. package/doc/functions/cork.md +1 -1
  26. package/doc/functions/defineCheckQuery.md +1 -1
  27. package/doc/functions/defineCustomFetch.md +1 -1
  28. package/doc/functions/defineGenericFetch.md +1 -1
  29. package/doc/functions/escapeRegex.md +1 -1
  30. package/doc/functions/fetchExternal.md +1 -1
  31. package/doc/functions/fetchLocal.md +1 -1
  32. package/doc/functions/fieldListFromFilter.md +1 -1
  33. package/doc/functions/filterChildren.md +1 -1
  34. package/doc/functions/filterFromValue.md +1 -1
  35. package/doc/functions/get.md +1 -1
  36. package/doc/functions/groupFilters.md +1 -1
  37. package/doc/functions/identity.md +1 -1
  38. package/doc/functions/intrinsicFilter.md +8 -8
  39. package/doc/functions/isFilterGroup.md +1 -1
  40. package/doc/functions/log.md +1 -1
  41. package/doc/functions/normalizeOrder.md +1 -1
  42. package/doc/functions/queryItemList.md +1 -1
  43. package/doc/functions/retry.md +1 -1
  44. package/doc/functions/reverseOrder.md +1 -1
  45. package/doc/functions/sameField.md +1 -1
  46. package/doc/functions/sortItemList.md +1 -1
  47. package/doc/functions/splitPath.md +2 -2
  48. package/doc/functions/testFilter.md +2 -2
  49. package/doc/functions/transformerFilterChildren.md +43 -0
  50. package/doc/interfaces/CustomFetch.md +1 -1
  51. package/doc/type-aliases/AggregateFunction.md +2 -2
  52. package/doc/type-aliases/AggregateFunctionOperator.md +1 -1
  53. package/doc/type-aliases/CombineUnion.md +1 -1
  54. package/doc/type-aliases/Context.md +8 -1
  55. package/doc/type-aliases/CustomFieldAggregateMap.md +1 -1
  56. package/doc/type-aliases/CustomFieldMap.md +1 -1
  57. package/doc/type-aliases/Field.md +1 -1
  58. package/doc/type-aliases/FieldFiltered.md +1 -1
  59. package/doc/type-aliases/FieldFunction.md +1 -1
  60. package/doc/type-aliases/FieldFunctionCustom.md +1 -1
  61. package/doc/type-aliases/FieldFunctionFormatDate.md +1 -1
  62. package/doc/type-aliases/FieldFunctionReturn.md +1 -1
  63. package/doc/type-aliases/FieldKey.md +1 -1
  64. package/doc/type-aliases/FieldMap.md +1 -1
  65. package/doc/type-aliases/Filter.md +1 -1
  66. package/doc/type-aliases/FilterArray.md +1 -1
  67. package/doc/type-aliases/FilterBoolean.md +1 -1
  68. package/doc/type-aliases/FilterChildren.md +2 -2
  69. package/doc/type-aliases/FilterCustom.md +1 -1
  70. package/doc/type-aliases/FilterField.md +1 -1
  71. package/doc/type-aliases/FilterGroup.md +7 -7
  72. package/doc/type-aliases/FilterNumber.md +1 -1
  73. package/doc/type-aliases/FilterOperator.md +1 -1
  74. package/doc/type-aliases/FilterString.md +1 -1
  75. package/doc/type-aliases/FilterStringIntersect.md +1 -1
  76. package/doc/type-aliases/FilterStringMatch.md +1 -1
  77. package/doc/type-aliases/Get.md +1 -1
  78. package/doc/type-aliases/Group.md +1 -1
  79. package/doc/type-aliases/Handler.md +1 -1
  80. package/doc/type-aliases/Immutable.md +1 -1
  81. package/doc/type-aliases/Increment.md +1 -1
  82. package/doc/type-aliases/InjectCustomFields.md +1 -1
  83. package/doc/type-aliases/IntersectUnion.md +1 -1
  84. package/doc/type-aliases/IntrinsicFilter.md +1 -1
  85. package/doc/type-aliases/Item.md +1 -1
  86. package/doc/type-aliases/Join.md +1 -1
  87. package/doc/type-aliases/Key.md +1 -1
  88. package/doc/type-aliases/KeyFiltered.md +1 -1
  89. package/doc/type-aliases/KeyFromUnion.md +1 -1
  90. package/doc/type-aliases/Locale.md +1 -1
  91. package/doc/type-aliases/NextHandler.md +1 -1
  92. package/doc/type-aliases/Order.md +1 -1
  93. package/doc/type-aliases/OrderNormalized.md +1 -1
  94. package/doc/type-aliases/Parameters.md +1 -1
  95. package/doc/type-aliases/Path.md +1 -1
  96. package/doc/type-aliases/PathFiltered.md +1 -1
  97. package/doc/type-aliases/Primitive.md +1 -1
  98. package/doc/type-aliases/PrimitiveObject.md +1 -1
  99. package/doc/type-aliases/Query.md +1 -1
  100. package/doc/type-aliases/QueryAggregate.md +1 -1
  101. package/doc/type-aliases/QueryCreate.md +1 -1
  102. package/doc/type-aliases/QueryCreateMultiple.md +1 -1
  103. package/doc/type-aliases/QueryDelete.md +1 -1
  104. package/doc/type-aliases/QueryDeleteMultiple.md +1 -1
  105. package/doc/type-aliases/QueryMethod.md +1 -1
  106. package/doc/type-aliases/QueryRead.md +1 -1
  107. package/doc/type-aliases/QueryReadMultiple.md +1 -1
  108. package/doc/type-aliases/QuerySettings.md +1 -1
  109. package/doc/type-aliases/QueryUpdate.md +1 -1
  110. package/doc/type-aliases/QueryUpdateMultiple.md +1 -1
  111. package/doc/type-aliases/Result.md +1 -1
  112. package/doc/type-aliases/Store.md +1 -1
  113. package/doc/type-aliases/Value.md +1 -1
  114. package/doc/type-aliases/ValueMap.md +1 -1
  115. package/doc/variables/CACHE.md +1 -1
  116. package/doc/variables/FILTER_ANY.md +1 -1
  117. package/doc/variables/FILTER_NONE.md +1 -1
  118. package/doc/variables/SELF.md +1 -1
  119. package/lib/tools/intrinsicFilter.ts +2 -2
  120. package/lib/tools/queryItemList.ts +2 -2
  121. package/lib/tools/testFilter.test.ts +5 -5
  122. package/lib/tools/testFilter.ts +8 -25
  123. package/lib/tools/transformerFilterChildren.ts +57 -0
  124. package/lib/tools.ts +1 -0
  125. package/lib/types/AggregateFunction.ts +2 -2
  126. package/lib/types/Context.ts +8 -0
  127. package/lib/types/FilterChildren.ts +1 -2
  128. package/lib/types/FilterGroup.ts +2 -2
  129. package/package.json +1 -1
@@ -18,7 +18,7 @@ Checks wether the provided `value` matches the `filter` or not.
18
18
 
19
19
  ### filter
20
20
 
21
- `undefined` | [`Filter`](../type-aliases/Filter.md)\<`T`\>
21
+ `undefined` | `NoInfer`\<[`Filter`](../type-aliases/Filter.md)\<`T`\>\>
22
22
 
23
23
  ### value
24
24
 
@@ -38,4 +38,4 @@ Optional query settings.
38
38
 
39
39
  ## Defined in
40
40
 
41
- [lib/tools/testFilter.ts:34](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/testFilter.ts#L34)
41
+ [lib/tools/testFilter.ts:25](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/tools/testFilter.ts#L25)
@@ -0,0 +1,43 @@
1
+ [**quetch**](../README.md)
2
+
3
+ ***
4
+
5
+ [quetch](../README.md) / transformerFilterChildren
6
+
7
+ # Function: transformerFilterChildren()
8
+
9
+ > **transformerFilterChildren**\<`T`\>(`options`): (`filter`) => [`FilterStringMatch`](../type-aliases/FilterStringMatch.md)\<`T`\>
10
+
11
+ Returns a function that transforms a `FilterChildren` into a `FilterStringMatch`.
12
+
13
+ ## Type Parameters
14
+
15
+ • **T**
16
+
17
+ ## Parameters
18
+
19
+ ### options
20
+
21
+ `TransformerFilterChildrenOptions`\<`T`\> = `EMPTY_OBJECT`
22
+
23
+ Options for the transformer.
24
+
25
+ ## Returns
26
+
27
+ `Function`
28
+
29
+ A function that takes a `FilterChildren` and returns a `FilterStringMatch` that matches the paths of the children of the item specified in the `FilterChildren`.
30
+
31
+ ### Parameters
32
+
33
+ #### filter
34
+
35
+ [`FilterChildren`](../type-aliases/FilterChildren.md)\<`T`\>
36
+
37
+ ### Returns
38
+
39
+ [`FilterStringMatch`](../type-aliases/FilterStringMatch.md)\<`T`\>
40
+
41
+ ## Defined in
42
+
43
+ [lib/tools/transformerFilterChildren.ts:39](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/tools/transformerFilterChildren.ts#L39)
@@ -28,4 +28,4 @@
28
28
 
29
29
  ## Defined in
30
30
 
31
- [lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/CustomFetch.ts#L5)
31
+ [lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/CustomFetch.ts#L5)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Type Alias: AggregateFunction\<T\>
8
8
 
9
- > **AggregateFunction**\<`T`\>: `"length"` \| \{`operator`: `"length"`; \} \| \{`filter`: [`Filter`](Filter.md)\<`T`\>;`last`: `boolean`;`operator`: `"index"`; \} \| \{`field`: [`Field`](Field.md)\<`T`\>;`operator`: `"median"` \| `"standardDeviation"` \| `"mean"` \| `"minimum"` \| `"maximum"` \| `"variance"` \| `"mode"`; \}
9
+ > **AggregateFunction**\<`T`\>: `"length"` \| \{`operator`: `"length"`; \} \| \{`filter`: [`Filter`](Filter.md)\<`T`\>;`last`: `boolean`;`operator`: `"index"`; \} \| \{`field`: [`Field`](Field.md)\<`T`\>;`operator`: `"median"` \| `"standardDeviation"` \| `"mean"` \| `"min"` \| `"max"` \| `"variance"` \| `"mode"`; \}
10
10
 
11
11
  Aggregation function.
12
12
 
@@ -16,4 +16,4 @@ Aggregation function.
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/AggregateFunction.ts:7](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/AggregateFunction.ts#L7)
19
+ [lib/types/AggregateFunction.ts:7](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/AggregateFunction.ts#L7)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/AggregateFunctionOperator.ts:3](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/AggregateFunctionOperator.ts#L3)
13
+ [lib/types/AggregateFunctionOperator.ts:3](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/AggregateFunctionOperator.ts#L3)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/CombineUnion.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/CombineUnion.ts#L4)
17
+ [lib/types/CombineUnion.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/CombineUnion.ts#L4)
@@ -8,10 +8,17 @@
8
8
 
9
9
  > **Context**\<`T`\>: [`0`] *extends* [`1` & `T`] ? `any` : `T` *extends* [`Primitive`](Primitive.md) ? `object` : `{ [K in keyof T]?: T[K] }`
10
10
 
11
+ Describes the entity so that it can be identified or selected in a filter.
12
+
13
+ The context of a single item (`query.multiple` is `false`) is typically its identifier.
14
+ The context of a list of items (`query.multiple` is `true`) typically consists of common properties that reference the parent entity.
15
+
16
+ It can be a partial object of the type `T` or a primitive value wrapped in an object with the `SELF` key.
17
+
11
18
  ## Type Parameters
12
19
 
13
20
  • **T**
14
21
 
15
22
  ## Defined in
16
23
 
17
- [lib/types/Context.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Context.ts#L5)
24
+ [lib/types/Context.ts:13](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Context.ts#L13)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/CustomFieldAggregateMap.ts:3](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/CustomFieldAggregateMap.ts#L3)
17
+ [lib/types/CustomFieldAggregateMap.ts:3](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/CustomFieldAggregateMap.ts#L3)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/CustomFieldMap.ts:3](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/CustomFieldMap.ts#L3)
17
+ [lib/types/CustomFieldMap.ts:3](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/CustomFieldMap.ts#L3)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/Field.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Field.ts#L5)
17
+ [lib/types/Field.ts:5](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Field.ts#L5)
@@ -16,4 +16,4 @@
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/FieldFiltered.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FieldFiltered.ts#L5)
19
+ [lib/types/FieldFiltered.ts:5](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FieldFiltered.ts#L5)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/FieldFunction.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FieldFunction.ts#L4)
17
+ [lib/types/FieldFunction.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FieldFunction.ts#L4)
@@ -36,4 +36,4 @@ Applies a custom field transform function.
36
36
 
37
37
  ## Defined in
38
38
 
39
- [lib/types/FieldFunctionCustom.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FieldFunctionCustom.ts#L4)
39
+ [lib/types/FieldFunctionCustom.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FieldFunctionCustom.ts#L4)
@@ -30,4 +30,4 @@ Formats the date found in a given field, which can be an ISO string date or a ti
30
30
 
31
31
  ## Defined in
32
32
 
33
- [lib/types/FieldFunctionFormatDate.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FieldFunctionFormatDate.ts#L6)
33
+ [lib/types/FieldFunctionFormatDate.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FieldFunctionFormatDate.ts#L6)
@@ -18,4 +18,4 @@ Return types of custom field functions.
18
18
 
19
19
  ## Defined in
20
20
 
21
- [lib/types/FieldFunctionReturn.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FieldFunctionReturn.ts#L4)
21
+ [lib/types/FieldFunctionReturn.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FieldFunctionReturn.ts#L4)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/FieldKey.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FieldKey.ts#L5)
17
+ [lib/types/FieldKey.ts:5](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FieldKey.ts#L5)
@@ -18,4 +18,4 @@ Maps the fields of the provided value `T` to a specific value `V`.
18
18
 
19
19
  ## Defined in
20
20
 
21
- [lib/types/FieldMap.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FieldMap.ts#L6)
21
+ [lib/types/FieldMap.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FieldMap.ts#L6)
@@ -16,4 +16,4 @@ Describes a predicate for filtering items.
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/Filter.ts:15](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Filter.ts#L15)
19
+ [lib/types/Filter.ts:15](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Filter.ts#L15)
@@ -32,4 +32,4 @@ Checks if a given array field matches a given array value according to a given o
32
32
 
33
33
  ## Defined in
34
34
 
35
- [lib/types/FilterArray.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterArray.ts#L11)
35
+ [lib/types/FilterArray.ts:11](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterArray.ts#L11)
@@ -26,4 +26,4 @@ Checks if a given boolean field is `true` or `false`.
26
26
 
27
27
  ## Defined in
28
28
 
29
- [lib/types/FilterBoolean.ts:7](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterBoolean.ts#L7)
29
+ [lib/types/FilterBoolean.ts:7](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterBoolean.ts#L7)
@@ -50,8 +50,8 @@ Minimum depth of the children to match. If `0`, matches the parent. If `1`, matc
50
50
 
51
51
  ### value?
52
52
 
53
- > `optional` **value**: [`Context`](Context.md)\<`T`\>
53
+ > `optional` **value**: `T`
54
54
 
55
55
  ## Defined in
56
56
 
57
- [lib/types/FilterChildren.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterChildren.ts#L9)
57
+ [lib/types/FilterChildren.ts:8](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterChildren.ts#L8)
@@ -36,4 +36,4 @@ Custom filter where `value(item)` returns `true` for matching items.
36
36
 
37
37
  ## Defined in
38
38
 
39
- [lib/types/FilterCustom.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterCustom.ts#L4)
39
+ [lib/types/FilterCustom.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterCustom.ts#L4)
@@ -28,4 +28,4 @@ The field name or path for which to check its existence.
28
28
 
29
29
  ## Defined in
30
30
 
31
- [lib/types/FilterField.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterField.ts#L6)
31
+ [lib/types/FilterField.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterField.ts#L6)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Type Alias: FilterGroup\<T\>
8
8
 
9
- > **FilterGroup**\<`T`\>: \{`operator`: `"all"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \} \| \{`maximum`: `number`;`minimum`: `number`;`operator`: `"any"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \} \| \{`operator`: `"none"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \}
9
+ > **FilterGroup**\<`T`\>: \{`operator`: `"all"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \} \| \{`max`: `number`;`min`: `number`;`operator`: `"any"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \} \| \{`operator`: `"none"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \}
10
10
 
11
11
  Joins a list of filters with a specific boolean operator.
12
12
 
@@ -30,11 +30,11 @@ Checks if all filters are true.
30
30
 
31
31
  Filters to join.
32
32
 
33
- \{`maximum`: `number`;`minimum`: `number`;`operator`: `"any"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \}
33
+ \{`max`: `number`;`min`: `number`;`operator`: `"any"`;`value`: readonly [`Filter`](Filter.md)\<`T`\>[]; \}
34
34
 
35
- ### maximum?
35
+ ### max?
36
36
 
37
- > `optional` **maximum**: `number`
37
+ > `optional` **max**: `number`
38
38
 
39
39
  Maximum number of filters that can match.
40
40
 
@@ -44,9 +44,9 @@ Maximum number of filters that can match.
44
44
  Infinity
45
45
  ```
46
46
 
47
- ### minimum?
47
+ ### min?
48
48
 
49
- > `optional` **minimum**: `number`
49
+ > `optional` **min**: `number`
50
50
 
51
51
  Minimum number of filters that must match.
52
52
 
@@ -84,4 +84,4 @@ Filters to join.
84
84
 
85
85
  ## Defined in
86
86
 
87
- [lib/types/FilterGroup.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterGroup.ts#L6)
87
+ [lib/types/FilterGroup.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterGroup.ts#L6)
@@ -26,4 +26,4 @@ Checks if a given number field matches a given number value according to a given
26
26
 
27
27
  ## Defined in
28
28
 
29
- [lib/types/FilterNumber.ts:7](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterNumber.ts#L7)
29
+ [lib/types/FilterNumber.ts:7](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterNumber.ts#L7)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/FilterOperator.ts:3](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterOperator.ts#L3)
13
+ [lib/types/FilterOperator.ts:3](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterOperator.ts#L3)
@@ -34,4 +34,4 @@ Checks if a given string field matches a given string value according to a given
34
34
 
35
35
  ## Defined in
36
36
 
37
- [lib/types/FilterString.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterString.ts#L8)
37
+ [lib/types/FilterString.ts:8](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterString.ts#L8)
@@ -34,4 +34,4 @@ Checks if a given string field has any of the provided values.
34
34
 
35
35
  ## Defined in
36
36
 
37
- [lib/types/FilterStringIntersect.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterStringIntersect.ts#L8)
37
+ [lib/types/FilterStringIntersect.ts:8](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterStringIntersect.ts#L8)
@@ -50,4 +50,4 @@ Ignore casing differences if `true`.
50
50
 
51
51
  ## Defined in
52
52
 
53
- [lib/types/FilterStringMatch.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/FilterStringMatch.ts#L9)
53
+ [lib/types/FilterStringMatch.ts:9](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/FilterStringMatch.ts#L9)
@@ -18,4 +18,4 @@ Returns the type of the property at the specified `P` path.
18
18
 
19
19
  ## Defined in
20
20
 
21
- [lib/types/Get.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Get.ts#L6)
21
+ [lib/types/Get.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Get.ts#L6)
@@ -16,4 +16,4 @@ Specifies how items should be grouped.
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/Group.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Group.ts#L4)
19
+ [lib/types/Group.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Group.ts#L4)
@@ -36,4 +36,4 @@ Handles an `input` query and returns an `output` promise, eventually using the `
36
36
 
37
37
  ## Defined in
38
38
 
39
- [lib/types/Handler.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Handler.ts#L6)
39
+ [lib/types/Handler.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Handler.ts#L6)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/Immutable.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Immutable.ts#L1)
17
+ [lib/types/Immutable.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Immutable.ts#L1)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/Increment.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Increment.ts#L5)
17
+ [lib/types/Increment.ts:5](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Increment.ts#L5)
@@ -18,4 +18,4 @@ Injects the custom fields into the entity type.
18
18
 
19
19
  ## Defined in
20
20
 
21
- [lib/types/InjectCustomFields.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/InjectCustomFields.ts#L8)
21
+ [lib/types/InjectCustomFields.ts:8](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/InjectCustomFields.ts#L8)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/IntersectUnion.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/IntersectUnion.ts#L1)
17
+ [lib/types/IntersectUnion.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/IntersectUnion.ts#L1)
@@ -16,4 +16,4 @@ Filter that does not rely on query settings, and thus can be evaluated directly
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/IntrinsicFilter.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/IntrinsicFilter.ts#L6)
19
+ [lib/types/IntrinsicFilter.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/IntrinsicFilter.ts#L6)
@@ -18,4 +18,4 @@ Returns the inferred item type of an array, or an alternative type if it is some
18
18
 
19
19
  ## Defined in
20
20
 
21
- [lib/types/Item.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Item.ts#L4)
21
+ [lib/types/Item.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Item.ts#L4)
@@ -16,4 +16,4 @@
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/Join.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Join.ts#L1)
19
+ [lib/types/Join.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Join.ts#L1)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/Key.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Key.ts#L1)
13
+ [lib/types/Key.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Key.ts#L1)
@@ -18,4 +18,4 @@ Returns union of keys whose mapped value extend the provided `P` type.
18
18
 
19
19
  ## Defined in
20
20
 
21
- [lib/types/KeyFiltered.ts:10](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/KeyFiltered.ts#L10)
21
+ [lib/types/KeyFiltered.ts:10](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/KeyFiltered.ts#L10)
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Defined in
16
16
 
17
- [lib/types/KeyFromUnion.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/KeyFromUnion.ts#L1)
17
+ [lib/types/KeyFromUnion.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/KeyFromUnion.ts#L1)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/Locale.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Locale.ts#L1)
13
+ [lib/types/Locale.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Locale.ts#L1)
@@ -28,4 +28,4 @@ Handles an `input` query and returns an `output` promise.
28
28
 
29
29
  ## Defined in
30
30
 
31
- [lib/types/NextHandler.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/NextHandler.ts#L4)
31
+ [lib/types/NextHandler.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/NextHandler.ts#L4)
@@ -16,4 +16,4 @@ Order item.
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/Order.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Order.ts#L6)
19
+ [lib/types/Order.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Order.ts#L6)
@@ -24,4 +24,4 @@
24
24
 
25
25
  ## Defined in
26
26
 
27
- [lib/types/OrderNormalized.ts:3](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/OrderNormalized.ts#L3)
27
+ [lib/types/OrderNormalized.ts:3](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/OrderNormalized.ts#L3)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/Parameters.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Parameters.ts#L1)
13
+ [lib/types/Parameters.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Parameters.ts#L1)
@@ -16,4 +16,4 @@
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/Path.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Path.ts#L5)
19
+ [lib/types/Path.ts:5](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Path.ts#L5)
@@ -18,4 +18,4 @@
18
18
 
19
19
  ## Defined in
20
20
 
21
- [lib/types/PathFiltered.ts:4](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/PathFiltered.ts#L4)
21
+ [lib/types/PathFiltered.ts:4](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/PathFiltered.ts#L4)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/Primitive.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Primitive.ts#L1)
13
+ [lib/types/Primitive.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Primitive.ts#L1)
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/PrimitiveObject.ts:1](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/PrimitiveObject.ts#L1)
13
+ [lib/types/PrimitiveObject.ts:1](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/PrimitiveObject.ts#L1)
@@ -16,4 +16,4 @@ Query that fetches or mutates an entity.
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/Query.ts:14](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Query.ts#L14)
19
+ [lib/types/Query.ts:14](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Query.ts#L14)
@@ -68,4 +68,4 @@ Query settings.
68
68
 
69
69
  ## Defined in
70
70
 
71
- [lib/types/QueryAggregate.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryAggregate.ts#L11)
71
+ [lib/types/QueryAggregate.ts:11](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryAggregate.ts#L11)
@@ -50,4 +50,4 @@ Value properties of the item to create.
50
50
 
51
51
  ## Defined in
52
52
 
53
- [lib/types/QueryCreate.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryCreate.ts#L8)
53
+ [lib/types/QueryCreate.ts:8](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryCreate.ts#L8)
@@ -48,4 +48,4 @@ Query settings.
48
48
 
49
49
  ## Defined in
50
50
 
51
- [lib/types/QueryCreateMultiple.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryCreateMultiple.ts#L8)
51
+ [lib/types/QueryCreateMultiple.ts:8](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryCreateMultiple.ts#L8)
@@ -60,4 +60,4 @@ Query settings.
60
60
 
61
61
  ## Defined in
62
62
 
63
- [lib/types/QueryDelete.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryDelete.ts#L9)
63
+ [lib/types/QueryDelete.ts:9](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryDelete.ts#L9)
@@ -62,4 +62,4 @@ Query settings.
62
62
 
63
63
  ## Defined in
64
64
 
65
- [lib/types/QueryDeleteMultiple.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryDeleteMultiple.ts#L9)
65
+ [lib/types/QueryDeleteMultiple.ts:9](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryDeleteMultiple.ts#L9)
@@ -12,4 +12,4 @@ Available query methods.
12
12
 
13
13
  ## Defined in
14
14
 
15
- [lib/types/QueryMethod.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryMethod.ts#L6)
15
+ [lib/types/QueryMethod.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryMethod.ts#L6)
@@ -76,4 +76,4 @@ Query settings.
76
76
 
77
77
  ## Defined in
78
78
 
79
- [lib/types/QueryRead.ts:10](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryRead.ts#L10)
79
+ [lib/types/QueryRead.ts:10](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryRead.ts#L10)
@@ -80,4 +80,4 @@ Query settings.
80
80
 
81
81
  ## Defined in
82
82
 
83
- [lib/types/QueryReadMultiple.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryReadMultiple.ts#L11)
83
+ [lib/types/QueryReadMultiple.ts:11](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryReadMultiple.ts#L11)
@@ -80,4 +80,4 @@ A filter that captures the items expressed by the provided `FilterChildren`.
80
80
 
81
81
  ## Defined in
82
82
 
83
- [lib/types/QuerySettings.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QuerySettings.ts#L8)
83
+ [lib/types/QuerySettings.ts:8](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QuerySettings.ts#L8)
@@ -68,4 +68,4 @@ Partial property values to update.
68
68
 
69
69
  ## Defined in
70
70
 
71
- [lib/types/QueryUpdate.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryUpdate.ts#L9)
71
+ [lib/types/QueryUpdate.ts:9](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryUpdate.ts#L9)
@@ -74,4 +74,4 @@ Partial property values to update.
74
74
 
75
75
  ## Defined in
76
76
 
77
- [lib/types/QueryUpdateMultiple.ts:10](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/QueryUpdateMultiple.ts#L10)
77
+ [lib/types/QueryUpdateMultiple.ts:10](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/QueryUpdateMultiple.ts#L10)
@@ -16,4 +16,4 @@
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/Result.ts:20](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Result.ts#L20)
19
+ [lib/types/Result.ts:20](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Result.ts#L20)
@@ -68,4 +68,4 @@
68
68
 
69
69
  ## Defined in
70
70
 
71
- [lib/types/Store.ts:2](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Store.ts#L2)
71
+ [lib/types/Store.ts:2](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Store.ts#L2)
@@ -36,4 +36,4 @@ Path leading to the value.
36
36
 
37
37
  ## Defined in
38
38
 
39
- [lib/types/Value.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/Value.ts#L6)
39
+ [lib/types/Value.ts:6](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Value.ts#L6)