quetch 0.15.0 → 0.16.0

package/doc/functions/fieldListFromFilter.md

@@ -0,0 +1,31 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / fieldListFromFilter
+
+# Function: fieldListFromFilter()
+
+> **fieldListFromFilter**\<`T`\>(`filter`?): readonly [`Field`](../type-aliases/Field.md)\<`T`\>[]
+
+Returns the list of fields used in the provided `filter`.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **filter?**: [`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+The filter to extract the fields from.
+
+## Returns
+
+readonly [`Field`](../type-aliases/Field.md)\<`T`\>[]
+
+A list of fields.
+
+## Defined in
+
+[lib/tools/fieldListFromFilter.ts:11](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/fieldListFromFilter.ts#L11)

package/doc/functions/filterChildren.md

@@ -0,0 +1,31 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / filterChildren
+
+# Function: filterChildren()
+
+> **filterChildren**\<`T`\>(`parentPath`, `pathFieldKey`, `deep`, `pathSeparator`): [`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **parentPath**: `string`
+
+• **pathFieldKey**: [`FieldFiltered`](../type-aliases/FieldFiltered.md)\<`T`, `string`\>
+
+• **deep**: `boolean` = `false`
+
+• **pathSeparator**: `string` = `"/"`
+
+## Returns
+
+[`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+## Defined in
+
+[lib/tools/filterChildren.ts:5](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/filterChildren.ts#L5)

package/doc/functions/filterFromContext.md

@@ -0,0 +1,25 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / filterFromContext
+
+# Function: filterFromContext()
+
+> **filterFromContext**\<`T`\>(`context`): [`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **context**: [`Context`](../type-aliases/Context.md)\<`T`\>
+
+## Returns
+
+[`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+## Defined in
+
+[lib/tools/filterFromContext.ts:5](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/filterFromContext.ts#L5)

package/doc/functions/get.md

@@ -0,0 +1,40 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / get
+
+# Function: get()
+
+> **get**\<`T`, `P`\>(`value`, `path`?): [`Get`](../type-aliases/Get.md)\<`T`, `P`\>
+
+Gets the property value of the given `value` at the specified `path` (an array of object property names or array indexes).
+If the `path` is undefined, returns the `value` itself.
+If the `path` is a string, it is considered as a path with one item.
+If the `path` leads to an unknown property, returns `undefined`.
+
+## Type Parameters
+
+• **T**
+
+• **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)\[\]]
+
+## Parameters
+
+• **value**: `T`
+
+The value from which to get the property value.
+
+• **path?**: `P`
+
+The path leading to the property value or a property name or `undefined`.
+
+## Returns
+
+[`Get`](../type-aliases/Get.md)\<`T`, `P`\>
+
+The property value found at the given path, or `undefined` if it cannot be found.
+
+## Defined in
+
+[lib/tools/get.ts:13](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/get.ts#L13)

package/doc/functions/identity.md

@@ -0,0 +1,33 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / identity
+
+# Function: identity()
+
+> **identity**\<`I`, `O`, `In`, `On`\>(`input`, `next`): `Promise`\<`O`\>
+
+## Type Parameters
+
+• **I**
+
+• **O**
+
+• **In**
+
+• **On**
+
+## Parameters
+
+• **input**: `I`
+
+• **next**: [`NextHandler`](../type-aliases/NextHandler.md)\<`In`, `On`\>
+
+## Returns
+
+`Promise`\<`O`\>
+
+## Defined in
+
+[lib/middlewares/identity.ts:3](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/middlewares/identity.ts#L3)

package/doc/functions/isFilterGroup.md

@@ -0,0 +1,31 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / isFilterGroup
+
+# Function: isFilterGroup()
+
+> **isFilterGroup**\<`T`\>(`value`): `value is FilterGroup<T>`
+
+Returns `true` if the provided filter `value` is a group filter or not.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **value**: `undefined` \| [`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+The filter to test.
+
+## Returns
+
+`value is FilterGroup<T>`
+
+Whether the provided filter is a group filter or not.
+
+## Defined in
+
+[lib/tools/isFilterGroup.ts:9](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/isFilterGroup.ts#L9)

package/doc/functions/log.md

@@ -0,0 +1,35 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / log
+
+# Function: log()
+
+> **log**\<`I`, `O`, `In`, `On`\>(`title`): [`Handler`](../type-aliases/Handler.md)\<`I`, `O`, `In`, `On`\>
+
+Logs the outgoing query and the incoming result or the error.
+
+## Type Parameters
+
+• **I**
+
+• **O**
+
+• **In**
+
+• **On**
+
+## Parameters
+
+• **title**: `string` = `"Query"`
+
+## Returns
+
+[`Handler`](../type-aliases/Handler.md)\<`I`, `O`, `In`, `On`\>
+
+Query handler
+
+## Defined in
+
+[lib/middlewares/log.ts:13](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/middlewares/log.ts#L13)

package/doc/functions/normalizeOrder.md

@@ -0,0 +1,39 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / normalizeOrder
+
+# Function: normalizeOrder()
+
+> **normalizeOrder**\<`T`\>(`order`): `object`
+
+Returns a normalized order, which is an object with the `field` and `descending` properties.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **order**: [`Order`](../type-aliases/Order.md)\<`T`\>
+
+The string or order object.
+
+## Returns
+
+`object`
+
+The normalized order object.
+
+### descending?
+
+> `optional` **descending**: `boolean`
+
+### field
+
+> **field**: [`Field`](../type-aliases/Field.md)\<`T`\>
+
+## Defined in
+
+[lib/tools/normalizeOrder.ts:11](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/normalizeOrder.ts#L11)

package/doc/functions/queryItemList.md

@@ -0,0 +1,33 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / queryItemList
+
+# Function: queryItemList()
+
+> **queryItemList**\<`T`, `Q`\>(`query`): [`Result`](../type-aliases/Result.md)\<`T`, `Q`\>
+
+Performs a provided `query` on local data, provided through the `query.type` property.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+• **Q** *extends* [`Query`](../type-aliases/Query.md)\<`T`\>
+
+## Parameters
+
+• **query**: `Q` & `object`
+
+The query to perform.
+
+## Returns
+
+[`Result`](../type-aliases/Result.md)\<`T`, `Q`\>
+
+The result of the query.
+
+## Defined in
+
+[lib/tools/queryItemList.ts:51](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/queryItemList.ts#L51)

package/doc/functions/retry.md

@@ -0,0 +1,33 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / retry
+
+# Function: retry()
+
+> **retry**(`options`): [`Handler`](../type-aliases/Handler.md)\<`Request`, `Response`, `Request`, `Response`\>
+
+Retries a failed query call up to `amount` times, with a given `delay` in milliseconds at ±`delayDelta` milliseconds.
+Note that an `amount` set to `Infinity` results in indefinitely trying to resolve a query call.
+Only instances of `RequestError` that do not result in a `500` status error will result in new tries. Other errors will propagate immediately.
+
+## Parameters
+
+• **options** = `{}`
+
+• **options.amount**: `undefined` \| `number` = `5`
+
+• **options.delay**: `undefined` \| `number` = `1000`
+
+• **options.delayDelta**: `undefined` \| `number` = `500`
+
+## Returns
+
+[`Handler`](../type-aliases/Handler.md)\<`Request`, `Response`, `Request`, `Response`\>
+
+Handler
+
+## Defined in
+
+[lib/middlewares/retry.ts:15](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/middlewares/retry.ts#L15)

package/doc/functions/reverseOrder.md

@@ -0,0 +1,39 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / reverseOrder
+
+# Function: reverseOrder()
+
+> **reverseOrder**\<`T`\>(`order`): `object`
+
+Reverses the provided `order`.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **order**: [`Order`](../type-aliases/Order.md)\<`T`\>
+
+The order to reverse.
+
+## Returns
+
+`object`
+
+The reversed order.
+
+### descending?
+
+> `optional` **descending**: `boolean`
+
+### field
+
+> **field**: [`Field`](../type-aliases/Field.md)\<`T`\>
+
+## Defined in
+
+[lib/tools/reverseOrder.ts:11](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/reverseOrder.ts#L11)

package/doc/functions/sortItemList.md

@@ -0,0 +1,35 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / sortItemList
+
+# Function: sortItemList()
+
+> **sortItemList**\<`T`\>(`orderList`, `value`): `T`[]
+
+Sorts provided `value` array according to the `orderList`.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **orderList**: `undefined` \| [`Order`](../type-aliases/Order.md)\<`T`\>[]
+
+The order to use for sorting.
+
+• **value**: `T`[]
+
+The array to sort.
+
+## Returns
+
+`T`[]
+
+A new sorted array.
+
+## Defined in
+
+[lib/tools/sortItemList.ts:13](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/sortItemList.ts#L13)

package/doc/functions/testFilter.md

@@ -0,0 +1,39 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / testFilter
+
+# Function: testFilter()
+
+> **testFilter**\<`T`\>(`filter`, `value`, `settings`?): `boolean`
+
+Checks wether the provided `value` matches the `filter` or not.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Parameters
+
+• **filter**: `undefined` \| [`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+The filter to apply.
+
+• **value**: `undefined` \| `T`
+
+The value to check.
+
+• **settings?**: [`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>
+
+Optional query settings.
+
+## Returns
+
+`boolean`
+
+`true` if the `value` matches the `filter` and `false` otherwise.
+
+## Defined in
+
+[lib/tools/testFilter.ts:28](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/tools/testFilter.ts#L28)

package/doc/interfaces/CustomFetch.md

@@ -1,35 +1,29 @@
-[quetch](../README.md) / CustomFetch
+[**quetch**](../README.md) • **Docs**
 
-# Interface: CustomFetch\<T\>
+***
 
-## Type parameters
+[quetch](../README.md) / CustomFetch
 
-| Name | Type |
-| :------ | :------ |
-| `T` | extends `object` |
+# Interface: CustomFetch()\<T\>
 
-## Callable
+## Type Parameters
 
-### CustomFetch
+• **T** *extends* `object`
 
-▸ **CustomFetch**\<`Q`\>(`query`): `Promise`\<[`Result`](../README.md#result)\<`T`, `Q`\>\>
+> **CustomFetch**\<`Q`\>(`query`): `Promise`\<[`Result`](../type-aliases/Result.md)\<`T`, `Q`\>\>
 
-#### Type parameters
+## Type Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `Q` | extends [`Query`](../README.md#query)\<`T`\> |
+• **Q** *extends* [`Query`](../type-aliases/Query.md)\<`T`\>
 
-#### Parameters
+## Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `query` | `Q` |
+• **query**: `Q`
 
-#### Returns
+## Returns
 
-`Promise`\<[`Result`](../README.md#result)\<`T`, `Q`\>\>
+`Promise`\<[`Result`](../type-aliases/Result.md)\<`T`, `Q`\>\>
 
-#### Defined in
+## Defined in
 
-[lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/b46dff0534f861059aba3484d2e1d047d841b31f/lib/types/CustomFetch.ts#L5)
+[lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/CustomFetch.ts#L5)

package/doc/type-aliases/AggregateFunction.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / AggregateFunction
+
+# Type Alias: AggregateFunction\<T\>
+
+> **AggregateFunction**\<`T`\>: `"length"` \| `object` \| `"index"` \| `object` \| `object`
+
+Aggregation function.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/AggregateFunction.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/AggregateFunction.ts#L6)

package/doc/type-aliases/AggregateFunctionOperator.md

@@ -0,0 +1,13 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / AggregateFunctionOperator
+
+# Type Alias: AggregateFunctionOperator
+
+> **AggregateFunctionOperator**: `Exclude`\<[`AggregateFunction`](AggregateFunction.md)\<`object`\>, `string`\>\[`"operator"`\]
+
+## Defined in
+
+[lib/types/AggregateFunctionOperator.ts:3](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/AggregateFunctionOperator.ts#L3)

package/doc/type-aliases/Any.md

@@ -0,0 +1,13 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Any
+
+# Type Alias: Any
+
+> **Any**: `boolean` \| `string` \| `number` \| `object` \| `symbol` \| `null` \| `undefined` \| `any`[] \| (...`args`) => `any`
+
+## Defined in
+
+[lib/types/Any.ts:1](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Any.ts#L1)

package/doc/type-aliases/Context.md

@@ -0,0 +1,17 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Context
+
+# Type Alias: Context\<T\>
+
+> **Context**\<`T`\>: `{ [K in keyof T]?: T[K] }`
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/Context.ts:1](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Context.ts#L1)

package/doc/type-aliases/CustomFieldAggregateMap.md

@@ -0,0 +1,17 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / CustomFieldAggregateMap
+
+# Type Alias: CustomFieldAggregateMap\<T\>
+
+> **CustomFieldAggregateMap**\<`T`\>: `Record`\<`string`, [`AggregateFunction`](AggregateFunction.md)\<`T`\>\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/CustomFieldAggregateMap.ts:3](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/CustomFieldAggregateMap.ts#L3)

package/doc/type-aliases/CustomFieldMap.md

@@ -0,0 +1,17 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / CustomFieldMap
+
+# Type Alias: CustomFieldMap\<T\>
+
+> **CustomFieldMap**\<`T`\>: `Record`\<`string`, [`FieldFunction`](FieldFunction.md)\<`T`\>\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/CustomFieldMap.ts:3](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/CustomFieldMap.ts#L3)

package/doc/type-aliases/Field.md

@@ -0,0 +1,17 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Field
+
+# Type Alias: Field\<T\>
+
+> **Field**\<`T`\>: keyof `T` \| [`Path`](Path.md)\<`T`\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/Field.ts:3](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Field.ts#L3)

package/doc/type-aliases/FieldFiltered.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FieldFiltered
+
+# Type Alias: FieldFiltered\<T, P\>
+
+> **FieldFiltered**\<`T`, `P`\>: [`KeyFiltered`](KeyFiltered.md)\<`Required`\<`T`\>, `P`\> \| [`PathFiltered`](PathFiltered.md)\<`Required`\<`T`\>, `P`\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+• **P**
+
+## Defined in
+
+[lib/types/FieldFiltered.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FieldFiltered.ts#L4)

package/doc/type-aliases/FieldFunction.md

@@ -0,0 +1,17 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FieldFunction
+
+# Type Alias: FieldFunction\<T\>
+
+> **FieldFunction**\<`T`\>: [`FieldFunctionCustom`](FieldFunctionCustom.md)\<`T`\> \| [`FieldFunctionFormatDate`](FieldFunctionFormatDate.md)\<`T`\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/FieldFunction.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FieldFunction.ts#L4)