quetch 0.19.0 → 0.19.2

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 (136) hide show
  1. package/dist/constants/CACHE.d.ts +1 -0
  2. package/dist/constants/CACHE.js +2 -0
  3. package/dist/constants/CACHE.js.map +1 -0
  4. package/dist/constants/SELF.d.ts +1 -0
  5. package/dist/constants/SELF.js +2 -0
  6. package/dist/constants/SELF.js.map +1 -0
  7. package/dist/constants.d.ts +2 -2
  8. package/dist/constants.js +2 -2
  9. package/dist/constants.js.map +1 -1
  10. package/dist/tools/get.js +2 -1
  11. package/dist/tools/get.js.map +1 -1
  12. package/dist/tools/testFilter.js +8 -8
  13. package/dist/tools/testFilter.js.map +1 -1
  14. package/dist/types/CombineUnion.d.ts +2 -1
  15. package/dist/types/FilterChildren.d.ts +2 -2
  16. package/dist/types/FilterStringMatch.d.ts +2 -2
  17. package/dist/types/KeyFiltered.d.ts +3 -5
  18. package/dist/types/Path.d.ts +1 -1
  19. package/dist/types/PathFiltered.d.ts +1 -1
  20. package/dist/types/Primitive.d.ts +1 -1
  21. package/dist/types/PrimitiveObject.d.ts +1 -0
  22. package/dist/types/PrimitiveObject.js +1 -0
  23. package/dist/types/PrimitiveObject.js.map +1 -0
  24. package/dist/types.d.ts +1 -0
  25. package/doc/README.md +6 -3
  26. package/doc/classes/RequestError.md +21 -11
  27. package/doc/functions/aggregate.md +21 -9
  28. package/doc/functions/branch.md +11 -5
  29. package/doc/functions/cache.md +21 -9
  30. package/doc/functions/combine.md +5 -3
  31. package/doc/functions/cork.md +5 -3
  32. package/doc/functions/defineCheckQuery.md +9 -5
  33. package/doc/functions/defineCustomFetch.md +15 -7
  34. package/doc/functions/defineGenericFetch.md +9 -5
  35. package/doc/functions/escapeRegex.md +5 -3
  36. package/doc/functions/fetchExternal.md +5 -3
  37. package/doc/functions/fetchLocal.md +3 -3
  38. package/doc/functions/fieldListFromFilter.md +6 -4
  39. package/doc/functions/filterChildren.md +15 -7
  40. package/doc/functions/filterFromContext.md +6 -4
  41. package/doc/functions/get.md +9 -5
  42. package/doc/functions/identity.md +8 -4
  43. package/doc/functions/isFilterGroup.md +5 -5
  44. package/doc/functions/log.md +5 -3
  45. package/doc/functions/normalizeOrder.md +6 -4
  46. package/doc/functions/queryItemList.md +6 -4
  47. package/doc/functions/retry.md +12 -6
  48. package/doc/functions/reverseOrder.md +6 -4
  49. package/doc/functions/sortItemList.md +10 -8
  50. package/doc/functions/testFilter.md +10 -8
  51. package/doc/interfaces/CustomFetch.md +6 -4
  52. package/doc/type-aliases/AggregateFunction.md +4 -4
  53. package/doc/type-aliases/AggregateFunctionOperator.md +2 -2
  54. package/doc/type-aliases/CombineUnion.md +17 -0
  55. package/doc/type-aliases/Context.md +3 -3
  56. package/doc/type-aliases/CustomFieldAggregateMap.md +3 -3
  57. package/doc/type-aliases/CustomFieldMap.md +3 -3
  58. package/doc/type-aliases/Field.md +4 -4
  59. package/doc/type-aliases/FieldFiltered.md +4 -4
  60. package/doc/type-aliases/FieldFunction.md +3 -3
  61. package/doc/type-aliases/FieldFunctionCustom.md +6 -4
  62. package/doc/type-aliases/FieldFunctionFormatDate.md +3 -3
  63. package/doc/type-aliases/FieldFunctionReturn.md +2 -2
  64. package/doc/type-aliases/Filter.md +3 -3
  65. package/doc/type-aliases/FilterArray.md +9 -5
  66. package/doc/type-aliases/FilterBoolean.md +3 -3
  67. package/doc/type-aliases/FilterChildren.md +5 -5
  68. package/doc/type-aliases/FilterCustom.md +6 -4
  69. package/doc/type-aliases/FilterField.md +3 -3
  70. package/doc/type-aliases/FilterGroup.md +34 -4
  71. package/doc/type-aliases/FilterNumber.md +3 -3
  72. package/doc/type-aliases/FilterOperator.md +2 -2
  73. package/doc/type-aliases/FilterString.md +3 -3
  74. package/doc/type-aliases/FilterStringIntersect.md +4 -4
  75. package/doc/type-aliases/FilterStringMatch.md +7 -7
  76. package/doc/type-aliases/Get.md +3 -3
  77. package/doc/type-aliases/Group.md +4 -4
  78. package/doc/type-aliases/Handler.md +8 -4
  79. package/doc/type-aliases/Immutable.md +3 -3
  80. package/doc/type-aliases/Increment.md +2 -2
  81. package/doc/type-aliases/InjectCustomFields.md +3 -3
  82. package/doc/type-aliases/IntersectUnion.md +17 -0
  83. package/doc/type-aliases/Item.md +2 -2
  84. package/doc/type-aliases/Join.md +2 -2
  85. package/doc/type-aliases/Key.md +2 -2
  86. package/doc/type-aliases/KeyFiltered.md +5 -5
  87. package/doc/type-aliases/KeyFromUnion.md +17 -0
  88. package/doc/type-aliases/Locale.md +3 -3
  89. package/doc/type-aliases/NextHandler.md +5 -3
  90. package/doc/type-aliases/Order.md +4 -4
  91. package/doc/type-aliases/Parameters.md +3 -3
  92. package/doc/type-aliases/Path.md +4 -4
  93. package/doc/type-aliases/PathFiltered.md +4 -4
  94. package/doc/type-aliases/Primitive.md +13 -0
  95. package/doc/type-aliases/PrimitiveObject.md +13 -0
  96. package/doc/type-aliases/Query.md +3 -3
  97. package/doc/type-aliases/QueryAggregate.md +4 -4
  98. package/doc/type-aliases/QueryCreate.md +3 -3
  99. package/doc/type-aliases/QueryCreateMultiple.md +4 -4
  100. package/doc/type-aliases/QueryDelete.md +3 -3
  101. package/doc/type-aliases/QueryDeleteMultiple.md +3 -3
  102. package/doc/type-aliases/QueryMethod.md +2 -2
  103. package/doc/type-aliases/QueryRead.md +4 -4
  104. package/doc/type-aliases/QueryReadMultiple.md +5 -5
  105. package/doc/type-aliases/QuerySettings.md +6 -4
  106. package/doc/type-aliases/QueryUpdate.md +3 -3
  107. package/doc/type-aliases/QueryUpdateMultiple.md +4 -4
  108. package/doc/type-aliases/Result.md +4 -4
  109. package/doc/type-aliases/Store.md +17 -7
  110. package/doc/type-aliases/Value.md +22 -4
  111. package/lib/constants/CACHE.ts +1 -0
  112. package/lib/constants/SELF.ts +1 -0
  113. package/lib/constants.ts +2 -2
  114. package/lib/tools/get.ts +2 -1
  115. package/lib/tools/testFilter.test.ts +2 -2
  116. package/lib/tools/testFilter.ts +8 -8
  117. package/lib/types/CombineUnion.ts +7 -4
  118. package/lib/types/FilterChildren.ts +2 -2
  119. package/lib/types/FilterStringMatch.ts +2 -2
  120. package/lib/types/KeyFiltered.ts +10 -21
  121. package/lib/types/Path.ts +8 -8
  122. package/lib/types/PathFiltered.ts +13 -11
  123. package/lib/types/Primitive.ts +1 -1
  124. package/lib/types/PrimitiveObject.ts +1 -0
  125. package/lib/types.ts +1 -0
  126. package/package.json +1 -1
  127. package/dist/constants/SymbolCache.d.ts +0 -1
  128. package/dist/constants/SymbolCache.js +0 -2
  129. package/dist/constants/SymbolCache.js.map +0 -1
  130. package/dist/constants/SymbolSelf.d.ts +0 -1
  131. package/dist/constants/SymbolSelf.js +0 -2
  132. package/dist/constants/SymbolSelf.js.map +0 -1
  133. package/doc/type-aliases/Any.md +0 -13
  134. package/doc/type-aliases/Mutable.md +0 -17
  135. package/lib/constants/SymbolCache.ts +0 -1
  136. package/lib/constants/SymbolSelf.ts +0 -1
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -16,7 +16,9 @@ Returns a custom fetch function that handles a `query`
16
16
 
17
17
  ## Parameters
18
18
 
19
- **handler**: [`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
19
+ ### handler
20
+
21
+ [`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
20
22
 
21
23
  The query handler.
22
24
 
@@ -36,7 +38,9 @@ A custom fetch function.
36
38
 
37
39
  ### Parameters
38
40
 
39
- **query**: `Q` & `object`
41
+ #### query
42
+
43
+ `Q` & `object`
40
44
 
41
45
  ### Returns
42
46
 
@@ -44,15 +48,19 @@ A custom fetch function.
44
48
 
45
49
  ### Type Parameters
46
50
 
47
- • **T** *extends* `object`
51
+ • **T**
48
52
 
49
53
  • **Q** *extends* [`Query`](../type-aliases/Query.md)\<`T`\>
50
54
 
51
55
  ### Parameters
52
56
 
53
- **type**: `T`[]
57
+ #### type
58
+
59
+ `T`[]
60
+
61
+ #### query
54
62
 
55
- • **query**: `Q`
63
+ `Q`
56
64
 
57
65
  ### Returns
58
66
 
@@ -60,4 +68,4 @@ A custom fetch function.
60
68
 
61
69
  ## Defined in
62
70
 
63
- [lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/defineCustomFetch.ts#L11)
71
+ [lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/defineCustomFetch.ts#L11)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -19,7 +19,9 @@ genericFetch<T>()(query)
19
19
 
20
20
  ## Parameters
21
21
 
22
- **handler**: [`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
22
+ ### handler
23
+
24
+ [`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
23
25
 
24
26
  The query handler.
25
27
 
@@ -31,7 +33,7 @@ A curried generic fetch function.
31
33
 
32
34
  ### Type Parameters
33
35
 
34
- • **T** *extends* `object`
36
+ • **T**
35
37
 
36
38
  ### Returns
37
39
 
@@ -43,7 +45,9 @@ A curried generic fetch function.
43
45
 
44
46
  #### Parameters
45
47
 
46
- **query**: `Q` & `object`
48
+ ##### query
49
+
50
+ `Q` & `object`
47
51
 
48
52
  #### Returns
49
53
 
@@ -51,4 +55,4 @@ A curried generic fetch function.
51
55
 
52
56
  ## Defined in
53
57
 
54
- [lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/defineGenericFetch.ts#L14)
58
+ [lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/defineGenericFetch.ts#L14)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,7 +12,9 @@ Escapes special characters of a given regular expresion `pattern`.
12
12
 
13
13
  ## Parameters
14
14
 
15
- **pattern**: `string`
15
+ ### pattern
16
+
17
+ `string`
16
18
 
17
19
  Regular expression string to escape.
18
20
 
@@ -24,4 +26,4 @@ Escaped regular expression
24
26
 
25
27
  ## Defined in
26
28
 
27
- [lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/escapeRegex.ts#L7)
29
+ [lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/escapeRegex.ts#L7)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,7 +12,9 @@ Calls the provided `fetch` function, which defaults to the DOM `fetch` function,
12
12
 
13
13
  ## Parameters
14
14
 
15
- **fetch** = `...`
15
+ ### fetch
16
+
17
+ (`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\>
16
18
 
17
19
  A standard `fetch` function.
18
20
 
@@ -24,4 +26,4 @@ Handler that returns a promise that resolves to the response.
24
26
 
25
27
  ## Defined in
26
28
 
27
- [lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/fetchExternal.ts#L12)
29
+ [lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/fetchExternal.ts#L12)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,7 +12,7 @@ Performs the fetch query on local data.
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Returns
18
18
 
@@ -22,4 +22,4 @@ Promise that resolves to the response.
22
22
 
23
23
  ## Defined in
24
24
 
25
- [lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/fetchLocal.ts#L9)
25
+ [lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/fetchLocal.ts#L9)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,11 +12,13 @@ Returns the list of fields used in the provided `filter`.
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Parameters
18
18
 
19
- **filter?**: [`Filter`](../type-aliases/Filter.md)\<`T`\>
19
+ ### filter?
20
+
21
+ [`Filter`](../type-aliases/Filter.md)\<`T`\>
20
22
 
21
23
  The filter to extract the fields from.
22
24
 
@@ -28,4 +30,4 @@ A list of fields.
28
30
 
29
31
  ## Defined in
30
32
 
31
- [lib/tools/fieldListFromFilter.ts:11](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/fieldListFromFilter.ts#L11)
33
+ [lib/tools/fieldListFromFilter.ts:11](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/fieldListFromFilter.ts#L11)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -10,17 +10,25 @@
10
10
 
11
11
  ## Type Parameters
12
12
 
13
- • **T** *extends* `object`
13
+ • **T**
14
14
 
15
15
  ## Parameters
16
16
 
17
- **parentPath**: `string`
17
+ ### parentPath
18
18
 
19
- • **pathFieldKey**: [`FieldFiltered`](../type-aliases/FieldFiltered.md)\<`T`, `string`\>
19
+ `string`
20
20
 
21
- **deep**: `boolean` = `false`
21
+ ### pathFieldKey
22
22
 
23
- • **pathSeparator**: `string` = `"/"`
23
+ [`FieldFiltered`](../type-aliases/FieldFiltered.md)\<`T`, `string`\>
24
+
25
+ ### deep
26
+
27
+ `boolean` = `false`
28
+
29
+ ### pathSeparator
30
+
31
+ `string` = `"/"`
24
32
 
25
33
  ## Returns
26
34
 
@@ -28,4 +36,4 @@
28
36
 
29
37
  ## Defined in
30
38
 
31
- [lib/tools/filterChildren.ts:5](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/filterChildren.ts#L5)
39
+ [lib/tools/filterChildren.ts:5](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/filterChildren.ts#L5)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -10,11 +10,13 @@
10
10
 
11
11
  ## Type Parameters
12
12
 
13
- • **T** *extends* `object`
13
+ • **T**
14
14
 
15
15
  ## Parameters
16
16
 
17
- **context**: [`Context`](../type-aliases/Context.md)\<`T`\>
17
+ ### context
18
+
19
+ [`Context`](../type-aliases/Context.md)\<`T`\>
18
20
 
19
21
  ## Returns
20
22
 
@@ -22,4 +24,4 @@
22
24
 
23
25
  ## Defined in
24
26
 
25
- [lib/tools/filterFromContext.ts:5](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/filterFromContext.ts#L5)
27
+ [lib/tools/filterFromContext.ts:7](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/filterFromContext.ts#L7)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -17,15 +17,19 @@ If the `path` leads to an unknown property, returns `undefined`.
17
17
 
18
18
  • **T**
19
19
 
20
- • **P** *extends* `string` \| `number` \| `symbol` \| [`number`] \| [keyof `T`\<`T`\>] \| [keyof `T`\<`T`\>, ...(T\<T\>\[keyof T\<T\>\] extends P\[\] ? \[number\] \| \[number, ...(P extends P\[\] ? \[number\] \| \[number, ...(P extends P\[\] ? \[number\] : P extends object ? (...)\[(...)\] : never)\[\]\] : P extends object ? \{ \[K in string \| number \| symbol\]-?: \[(...)\] \| \[(...), ...(...)\[\]\] \}\[keyof P\<P\>\] : never)\[\]\] : T\<T\>\[keyof T\<T\>\] extends object ? \{ \[K in string \| number \| symbol\]-?: \[K\] \| \[K, ...(any\[any\]\[K\] extends P\[\] ? \[(...)\] \| \[(...), ...(...)\[\]\] : (...)\[(...)\] extends object ? (...)\[(...)\] : never)\[\]\] \}\[keyof any\[any\]\] : never)\[\]]
20
+ • **P** *extends* `string` \| `number` \| `symbol` \| readonly [`number`] \| readonly `never`[] \| readonly [`Key`](../type-aliases/Key.md)[] \| [keyof `T`\<`T`\>] \| [keyof `T`\<`T`\>, `...Path<T<T>[keyof T<T>], 8>[]`]
21
21
 
22
22
  ## Parameters
23
23
 
24
- **value**: `T`
24
+ ### value
25
+
26
+ `T`
25
27
 
26
28
  The value from which to get the property value.
27
29
 
28
- **path?**: `P`
30
+ ### path?
31
+
32
+ `P`
29
33
 
30
34
  The path leading to the property value or a property name or `undefined`.
31
35
 
@@ -37,4 +41,4 @@ The property value found at the given path, or `undefined` if it cannot be found
37
41
 
38
42
  ## Defined in
39
43
 
40
- [lib/tools/get.ts:13](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/get.ts#L13)
44
+ [lib/tools/get.ts:14](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/get.ts#L14)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -20,9 +20,13 @@
20
20
 
21
21
  ## Parameters
22
22
 
23
- **input**: `I`
23
+ ### input
24
24
 
25
- • **next**: [`NextHandler`](../type-aliases/NextHandler.md)\<`In`, `On`\>
25
+ `I`
26
+
27
+ ### next
28
+
29
+ [`NextHandler`](../type-aliases/NextHandler.md)\<`In`, `On`\>
26
30
 
27
31
  ## Returns
28
32
 
@@ -30,4 +34,4 @@
30
34
 
31
35
  ## Defined in
32
36
 
33
- [lib/middlewares/identity.ts:3](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/identity.ts#L3)
37
+ [lib/middlewares/identity.ts:3](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/identity.ts#L3)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,13 +12,13 @@ Returns `true` if the provided filter `value` is a group filter or not.
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Parameters
18
18
 
19
- **value**: `undefined` \| [`Filter`](../type-aliases/Filter.md)\<`T`\>
19
+ ### value
20
20
 
21
- The filter to test.
21
+ `undefined` | [`Filter`](../type-aliases/Filter.md)\<`T`\>
22
22
 
23
23
  ## Returns
24
24
 
@@ -28,4 +28,4 @@ Whether the provided filter is a group filter or not.
28
28
 
29
29
  ## Defined in
30
30
 
31
- [lib/tools/isFilterGroup.ts:9](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/isFilterGroup.ts#L9)
31
+ [lib/tools/isFilterGroup.ts:9](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/isFilterGroup.ts#L9)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -22,7 +22,9 @@ Logs the outgoing query and the incoming result or the error.
22
22
 
23
23
  ## Parameters
24
24
 
25
- **title**: `string` = `"Query"`
25
+ ### title
26
+
27
+ `string` = `"Query"`
26
28
 
27
29
  ## Returns
28
30
 
@@ -32,4 +34,4 @@ Query handler
32
34
 
33
35
  ## Defined in
34
36
 
35
- [lib/middlewares/log.ts:13](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/log.ts#L13)
37
+ [lib/middlewares/log.ts:13](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/log.ts#L13)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,11 +12,13 @@ Returns a normalized order, which is an object with the `field` and `descending`
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Parameters
18
18
 
19
- **order**: [`Order`](../type-aliases/Order.md)\<`T`\>
19
+ ### order
20
+
21
+ [`Order`](../type-aliases/Order.md)\<`T`\>
20
22
 
21
23
  The string or order object.
22
24
 
@@ -36,4 +38,4 @@ The normalized order object.
36
38
 
37
39
  ## Defined in
38
40
 
39
- [lib/tools/normalizeOrder.ts:11](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/normalizeOrder.ts#L11)
41
+ [lib/tools/normalizeOrder.ts:11](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/normalizeOrder.ts#L11)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,13 +12,15 @@ Performs a provided `query` on local data, provided through the `query.type` pro
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  • **Q** *extends* [`Query`](../type-aliases/Query.md)\<`T`\>
18
18
 
19
19
  ## Parameters
20
20
 
21
- **query**: `Q` & `object`
21
+ ### query
22
+
23
+ `Q` & `object`
22
24
 
23
25
  The query to perform.
24
26
 
@@ -30,4 +32,4 @@ The result of the query.
30
32
 
31
33
  ## Defined in
32
34
 
33
- [lib/tools/queryItemList.ts:48](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/queryItemList.ts#L48)
35
+ [lib/tools/queryItemList.ts:48](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/queryItemList.ts#L48)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -14,13 +14,19 @@ Only instances of `RequestError` that do not result in a `500` status error will
14
14
 
15
15
  ## Parameters
16
16
 
17
- **options** = `{}`
17
+ ### options
18
18
 
19
- **options.amount**: `undefined` \| `number` = `5`
19
+ #### options.amount
20
20
 
21
- • **options.delay**: `undefined` \| `number` = `1000`
21
+ `number` = `5`
22
22
 
23
- **options.delayDelta**: `undefined` \| `number` = `500`
23
+ #### options.delay
24
+
25
+ `number` = `1000`
26
+
27
+ #### options.delayDelta
28
+
29
+ `number` = `500`
24
30
 
25
31
  ## Returns
26
32
 
@@ -30,4 +36,4 @@ Handler
30
36
 
31
37
  ## Defined in
32
38
 
33
- [lib/middlewares/retry.ts:15](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/retry.ts#L15)
39
+ [lib/middlewares/retry.ts:15](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/retry.ts#L15)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,11 +12,13 @@ Reverses the provided `order`.
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Parameters
18
18
 
19
- **order**: [`Order`](../type-aliases/Order.md)\<`T`\>
19
+ ### order
20
+
21
+ [`Order`](../type-aliases/Order.md)\<`T`\>
20
22
 
21
23
  The order to reverse.
22
24
 
@@ -36,4 +38,4 @@ The reversed order.
36
38
 
37
39
  ## Defined in
38
40
 
39
- [lib/tools/reverseOrder.ts:11](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/reverseOrder.ts#L11)
41
+ [lib/tools/reverseOrder.ts:11](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/reverseOrder.ts#L11)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,30 +6,32 @@
6
6
 
7
7
  # Function: sortItemList()
8
8
 
9
- > **sortItemList**\<`T`\>(`orderList`, `value`): `T`[]
9
+ > **sortItemList**\<`T`\>(`orderList`, `value`): readonly `T`[]
10
10
 
11
11
  Sorts provided `value` array according to the `orderList`.
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Parameters
18
18
 
19
- **orderList**: `undefined` \| [`Order`](../type-aliases/Order.md)\<`T`\>[]
19
+ ### orderList
20
20
 
21
- The order to use for sorting.
21
+ `undefined` | readonly [`Order`](../type-aliases/Order.md)\<`T`\>[]
22
22
 
23
- **value**: `T`[]
23
+ ### value
24
+
25
+ readonly `T`[]
24
26
 
25
27
  The array to sort.
26
28
 
27
29
  ## Returns
28
30
 
29
- `T`[]
31
+ readonly `T`[]
30
32
 
31
33
  A new sorted array.
32
34
 
33
35
  ## Defined in
34
36
 
35
- [lib/tools/sortItemList.ts:13](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/sortItemList.ts#L13)
37
+ [lib/tools/sortItemList.ts:13](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/sortItemList.ts#L13)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -12,19 +12,21 @@ Checks wether the provided `value` matches the `filter` or not.
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Parameters
18
18
 
19
- **filter**: `undefined` \| [`Filter`](../type-aliases/Filter.md)\<`T`\>
19
+ ### filter
20
20
 
21
- The filter to apply.
21
+ `undefined` | [`Filter`](../type-aliases/Filter.md)\<`T`\>
22
22
 
23
- **value**: `undefined` \| `T`
23
+ ### value
24
24
 
25
- The value to check.
25
+ `undefined` | `T`
26
26
 
27
- **settings?**: [`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>
27
+ ### settings?
28
+
29
+ [`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>
28
30
 
29
31
  Optional query settings.
30
32
 
@@ -36,4 +38,4 @@ Optional query settings.
36
38
 
37
39
  ## Defined in
38
40
 
39
- [lib/tools/testFilter.ts:28](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/testFilter.ts#L28)
41
+ [lib/tools/testFilter.ts:26](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/testFilter.ts#L26)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Type Parameters
10
10
 
11
- • **T** *extends* `object`
11
+ • **T**
12
12
 
13
13
  > **CustomFetch**\<`Q`\>(`query`): `Promise`\<[`Result`](../type-aliases/Result.md)\<`T`, `Q`\>\>
14
14
 
@@ -18,7 +18,9 @@
18
18
 
19
19
  ## Parameters
20
20
 
21
- **query**: `Q`
21
+ ### query
22
+
23
+ `Q`
22
24
 
23
25
  ## Returns
24
26
 
@@ -26,4 +28,4 @@
26
28
 
27
29
  ## Defined in
28
30
 
29
- [lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/types/CustomFetch.ts#L5)
31
+ [lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/types/CustomFetch.ts#L5)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,14 +6,14 @@
6
6
 
7
7
  # Type Alias: AggregateFunction\<T\>
8
8
 
9
- > **AggregateFunction**\<`T`\>: `"length"` \| `object` \| `object` \| `object`
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"`; \}
10
10
 
11
11
  Aggregation function.
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- • **T** *extends* `object`
15
+ • **T**
16
16
 
17
17
  ## Defined in
18
18
 
19
- [lib/types/AggregateFunction.ts:6](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/types/AggregateFunction.ts#L6)
19
+ [lib/types/AggregateFunction.ts:7](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/types/AggregateFunction.ts#L7)
@@ -1,4 +1,4 @@
1
- [**quetch**](../README.md) • **Docs**
1
+ [**quetch**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Defined in
12
12
 
13
- [lib/types/AggregateFunctionOperator.ts:3](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/types/AggregateFunctionOperator.ts#L3)
13
+ [lib/types/AggregateFunctionOperator.ts:3](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/types/AggregateFunctionOperator.ts#L3)