quetch 0.19.1 → 0.19.2

package/dist/types/CombineUnion.d.ts

@@ -1,5 +1,6 @@
 import type { KeyFromUnion } from "./KeyFromUnion";
-export type CombineUnion<U> = [0] extends [1 & U] ? any : [U] extends [Function | readonly Function[]] ? undefined : [U] extends readonly [Array<any>] ? U : {
+import type { Primitive } from "./Primitive";
+export type CombineUnion<U> = [0] extends [1 & U] ? any : [U] extends [Function | readonly Function[]] ? undefined : [U] extends [Primitive] ? U : [U] extends readonly [Array<any>] ? U : {
     [K in KeyFromUnion<U>]: Continue<Combine<U, K>>;
 };
 type Combine<U, K extends string | number | symbol> = Exclude<Extract<U, {

package/dist/types/KeyFiltered.d.ts

@@ -1,12 +1,10 @@
 import type { SELF } from "../constants/SELF";
 import type { Key } from "./Key";
-import type { Primitive } from "./Primitive";
 type SymbolSelf = typeof SELF;
 /**
  * Returns union of keys whose mapped value extend the provided `P` type.
  */
-export type KeyFiltered<T, P> = [0] extends [1 & T] ? Key | SymbolSelf : T extends object ? T extends Primitive ? [MapPrimitive<T>] extends [P] ? SymbolSelf : never : keyof {
+export type KeyFiltered<T, P> = [0] extends [1 & T] ? Key | SymbolSelf : T extends string | number | boolean | bigint | symbol ? T extends P ? SymbolSelf : never : T extends object ? keyof {
     [K in keyof T as Extract<T[K], P> extends never ? never : K]-?: T[K];
 } : never;
-type MapPrimitive<P> = P extends String ? string : P extends Number ? number : P extends Boolean ? boolean : P extends BigInt ? bigint : never;
 export {};

package/dist/types/Path.d.ts

@@ -1,6 +1,6 @@
 import type { Increment } from "./Increment";
 import type { Key } from "./Key";
 import type { Primitive } from "./Primitive";
-export type Path<T, D = 7> = [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends Array<infer P> ? readonly [number] | readonly [number, ...Path<P, Increment<D>>] : T extends object ? T extends Primitive ? readonly never[] : {
+export type Path<T, D = 7> = [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends Primitive ? readonly never[] : T extends Array<infer P> ? readonly [number] | readonly [number, ...Path<P, Increment<D>>] : T extends object ? {
     [K in keyof T]: [K] | [K, ...Path<T[K], Increment<D>>];
 }[keyof T] : never;

package/dist/types/PathFiltered.d.ts

@@ -1,5 +1,5 @@
 import type { Increment } from "./Increment";
 import type { Key } from "./Key";
-export type PathFiltered<T, P, D = 7> = [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends ReadonlyArray<infer I> ? Extract<I, P> extends never ? readonly [number, ...PathFiltered<I, P, Increment<D>>] : readonly [number] : T extends object ? {
+export type PathFiltered<T, P, D = 7> = [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends P ? readonly never[] : T extends ReadonlyArray<infer I> ? Extract<I, P> extends never ? readonly [number, ...PathFiltered<I, P, Increment<D>>] : readonly [number] : T extends object ? {
     [K in keyof T]: Extract<T[K], P> extends never ? readonly [K, ...PathFiltered<T[K], P, Increment<D>>] : readonly [K];
 }[keyof T] : never;

package/dist/types/Primitive.d.ts

@@ -1 +1 @@
-export type Primitive = String | Number | Boolean | BigInt;
+export type Primitive = string | number | boolean | bigint | symbol;

package/dist/types/PrimitiveObject.d.ts

@@ -0,0 +1 @@
+export type PrimitiveObject = String | Number | Boolean | BigInt | Symbol;

package/dist/types/PrimitiveObject.js

@@ -0,0 +1 @@
+//# sourceMappingURL=PrimitiveObject.js.map

package/dist/types/PrimitiveObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrimitiveObject.js","sourceRoot":"","sources":["../../lib/types/PrimitiveObject.ts"],"names":[],"mappings":""}

package/dist/types.d.ts

@@ -42,6 +42,7 @@ export type { Parameters } from "./types/Parameters";
 export type { Path } from "./types/Path";
 export type { PathFiltered } from "./types/PathFiltered";
 export type { Primitive } from "./types/Primitive";
+export type { PrimitiveObject } from "./types/PrimitiveObject";
 export type { Query } from "./types/Query";
 export type { QueryAggregate } from "./types/QueryAggregate";
 export type { QueryCreate } from "./types/QueryCreate";

package/doc/README.md

@@ -1,4 +1,4 @@
-**quetch** • **Docs**
+**quetch**
 
 ***
 
@@ -16,7 +16,7 @@
 
 - [AggregateFunction](type-aliases/AggregateFunction.md)
 - [AggregateFunctionOperator](type-aliases/AggregateFunctionOperator.md)
-- [Any](type-aliases/Any.md)
+- [CombineUnion](type-aliases/CombineUnion.md)
 - [Context](type-aliases/Context.md)
 - [CustomFieldAggregateMap](type-aliases/CustomFieldAggregateMap.md)
 - [CustomFieldMap](type-aliases/CustomFieldMap.md)
@@ -44,17 +44,20 @@
 - [Immutable](type-aliases/Immutable.md)
 - [Increment](type-aliases/Increment.md)
 - [InjectCustomFields](type-aliases/InjectCustomFields.md)
+- [IntersectUnion](type-aliases/IntersectUnion.md)
 - [Item](type-aliases/Item.md)
 - [Join](type-aliases/Join.md)
 - [Key](type-aliases/Key.md)
 - [KeyFiltered](type-aliases/KeyFiltered.md)
+- [KeyFromUnion](type-aliases/KeyFromUnion.md)
 - [Locale](type-aliases/Locale.md)
-- [Mutable](type-aliases/Mutable.md)
 - [NextHandler](type-aliases/NextHandler.md)
 - [Order](type-aliases/Order.md)
 - [Parameters](type-aliases/Parameters.md)
 - [Path](type-aliases/Path.md)
 - [PathFiltered](type-aliases/PathFiltered.md)
+- [Primitive](type-aliases/Primitive.md)
+- [PrimitiveObject](type-aliases/PrimitiveObject.md)
 - [Query](type-aliases/Query.md)
 - [QueryAggregate](type-aliases/QueryAggregate.md)
 - [QueryCreate](type-aliases/QueryCreate.md)

package/doc/classes/RequestError.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -20,15 +20,25 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Parameters
 
-• **message**: `string`
+##### message
 
-• **status**: `number`
+`string`
 
-• **query?**: [`Query`](../type-aliases/Query.md)\<`any`\>
+##### status
 
-• **request?**: `Request`
+`number`
 
-• **response?**: `Response`
+##### query?
+
+[`Query`](../type-aliases/Query.md)\<`any`\>
+
+##### request?
+
+`Request`
+
+##### response?
+
+`Response`
 
 #### Returns
 
@@ -40,7 +50,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/errors/RequestError.ts#L7)
+[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/errors/RequestError.ts#L7)
 
 ## Properties
 
@@ -50,7 +60,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/errors/RequestError.ts#L10)
+[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/errors/RequestError.ts#L10)
 
 ***
 
@@ -60,7 +70,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/errors/RequestError.ts#L11)
+[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/errors/RequestError.ts#L11)
 
 ***
 
@@ -70,7 +80,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/errors/RequestError.ts#L12)
+[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/errors/RequestError.ts#L12)
 
 ***
 
@@ -80,4 +90,4 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/errors/RequestError.ts#L9)
+[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/errors/RequestError.ts#L9)

package/doc/functions/aggregate.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -26,19 +26,31 @@ If a query occurs twice, `mergeQuery(query, currentQuery)` is called and the out
 
 ## Parameters
 
-• **options**
+### options
 
-• **options.delay?**: `number` = `200`
+#### options.delay
 
-• **options.mergeQuery?** = `...`
+`number` = `200`
 
-• **options.queryForGroup** = `...`
+#### options.mergeQuery
 
-• **options.queryGroupId?** = `...`
+(`query`, `currentQuery`) => `I` = `...`
 
-• **options.queryId?** = `...`
+#### options.queryForGroup
 
-• **options.resultForQuery** = `...`
+(`queryList`, `group`) => [`Query`](../type-aliases/Query.md)\<`any`\> & `object` = `...`
+
+#### options.queryGroupId
+
+(`query`) => `undefined` \| `string` = `...`
+
+#### options.queryId
+
+(`query`) => `undefined` \| `string` = `...`
+
+#### options.resultForQuery
+
+(`resultList`, `query`) => `O` = `...`
 
 ## Returns
 
@@ -46,4 +58,4 @@ If a query occurs twice, `mergeQuery(query, currentQuery)` is called and the out
 
 ## Defined in
 
-[lib/middlewares/aggregate.ts:16](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/aggregate.ts#L16)
+[lib/middlewares/aggregate.ts:16](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/aggregate.ts#L16)

package/doc/functions/branch.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -22,11 +22,17 @@ Dispatches an incoming query to `left` if `condition(query)` returns a truthy va
 
 ## Parameters
 
-• **condition**
+### condition
 
-• **left**: [`Handler`](../type-aliases/Handler.md)\<`I`, `O`, `In`, `On`\>
+(`input`) => `boolean`
 
-• **right**: [`Handler`](../type-aliases/Handler.md)\<`I`, `O`, `In`, `On`\> = `...`
+### left
+
+[`Handler`](../type-aliases/Handler.md)\<`I`, `O`, `In`, `On`\>
+
+### right
+
+[`Handler`](../type-aliases/Handler.md)\<`I`, `O`, `In`, `On`\> = `...`
 
 ## Returns
 
@@ -43,4 +49,4 @@ const customFetch = combine(
 
 ## Defined in
 
-[lib/middlewares/branch.ts:21](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/branch.ts#L21)
+[lib/middlewares/branch.ts:21](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/branch.ts#L21)

package/doc/functions/cache.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -20,33 +20,45 @@
 
 ## Parameters
 
-• **\_\_namedParameters**
+### \_\_namedParameters
 
-• **\_\_namedParameters.extendCachedQuery**
+#### __namedParameters.extendCachedQuery
+
+(`query`, `cachedQuery`) => `undefined` \| `I`
 
 Returns a query that completes the cached value.
 Returns `undefined` if the query should not be completed.
 
-• **\_\_namedParameters.invalidatesItem**
+#### __namedParameters.invalidatesItem
+
+(`query`, `cachedQuery`, `cachedValue`) => `boolean`
 
 Returns `true` if the cached item must be invalidated.
 
-• **\_\_namedParameters.itemId?** = `...`
+#### __namedParameters.itemId
+
+(`query`) => `undefined` \| `string` = `...`
 
 Unique identifier for the item to cache.
 Returns `undefined` if the item should not be cached.
 
-• **\_\_namedParameters.mergeItem**
+#### __namedParameters.mergeItem
+
+(`value`, `cachedValue`, `query`, `cachedQuery`) => `any`
 
 Merges the value from the extended query with the cached value.
 Only called when `extendCachedQuery` returns a query.
 
-• **\_\_namedParameters.mergeQuery**
+#### __namedParameters.mergeQuery
+
+(`extendedQuery`, `cachedQuery`) => `I`
 
 Merges the extended query with the cached query.
 Only called when `extendCachedQuery` returns a query.
 
-• **\_\_namedParameters.store**: [`Store`](../type-aliases/Store.md)\<`CachedItem`\<`I`\>\>
+#### __namedParameters.store
+
+[`Store`](../type-aliases/Store.md)\<`CachedItem`\<`I`\>\>
 
 Cache store.
 
@@ -56,4 +68,4 @@ Cache store.
 
 ## Defined in
 
-[lib/middlewares/cache.ts:8](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/cache.ts#L8)
+[lib/middlewares/cache.ts:8](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/cache.ts#L8)

package/doc/functions/combine.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -102,7 +102,9 @@ Combines the provided handler into a single handler.
 
 ## Parameters
 
-• ...**handlerList**: readonly [[`Handler`](../type-aliases/Handler.md)\<`I0`, `O0`, `I1`, `O1`\>, [`Handler`](../type-aliases/Handler.md)\<`I1`, `O1`, `I2`, `O2`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I2`, `O2`, `I3`, `O3`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I3`, `O3`, `I4`, `O4`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I4`, `O4`, `I5`, `O5`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I5`, `O5`, `I6`, `O6`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I6`, `O6`, `I7`, `O7`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I7`, `O7`, `I8`, `O8`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I8`, `O8`, `I9`, `O9`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I9`, `O9`, `I10`, `O10`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I10`, `O10`, `I11`, `O11`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I11`, `O11`, `I12`, `O12`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I12`, `O12`, `I13`, `O13`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I13`, `O13`, `I14`, `O14`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I14`, `O14`, `I15`, `O15`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I15`, `O15`, `I16`, `O16`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I16`, `O16`, `I17`, `O17`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I17`, `O17`, `I18`, `O18`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I18`, `O18`, `I19`, `O19`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I19`, `O19`, `I20`, `O20`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I20`, `O20`, `I21`, `O21`\>]
+### handlerList
+
+...readonly [[`Handler`](../type-aliases/Handler.md)\<`I0`, `O0`, `I1`, `O1`\>, [`Handler`](../type-aliases/Handler.md)\<`I1`, `O1`, `I2`, `O2`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I2`, `O2`, `I3`, `O3`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I3`, `O3`, `I4`, `O4`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I4`, `O4`, `I5`, `O5`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I5`, `O5`, `I6`, `O6`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I6`, `O6`, `I7`, `O7`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I7`, `O7`, `I8`, `O8`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I8`, `O8`, `I9`, `O9`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I9`, `O9`, `I10`, `O10`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I10`, `O10`, `I11`, `O11`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I11`, `O11`, `I12`, `O12`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I12`, `O12`, `I13`, `O13`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I13`, `O13`, `I14`, `O14`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I14`, `O14`, `I15`, `O15`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I15`, `O15`, `I16`, `O16`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I16`, `O16`, `I17`, `O17`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I17`, `O17`, `I18`, `O18`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I18`, `O18`, `I19`, `O19`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I19`, `O19`, `I20`, `O20`\>, `undefined` \| [`Handler`](../type-aliases/Handler.md)\<`I20`, `O20`, `I21`, `O21`\>]
 
 List of handlers to combine.
 
@@ -114,4 +116,4 @@ Handler that combines all provided handlers.
 
 ## Defined in
 
-[lib/middlewares/combine.ts:801](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/combine.ts#L801)
+[lib/middlewares/combine.ts:801](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/combine.ts#L801)

package/doc/functions/cork.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -12,7 +12,9 @@ Uncallable handler used to terminate a sequence of handlers combined with `combi
 
 ## Parameters
 
-• **input**: `never`
+### input
+
+`never`
 
 ## Returns
 
@@ -20,4 +22,4 @@ Uncallable handler used to terminate a sequence of handlers combined with `combi
 
 ## Defined in
 
-[lib/tools/cork.ts:6](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/cork.ts#L6)
+[lib/tools/cork.ts:6](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/cork.ts#L6)

package/doc/functions/defineCheckQuery.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -22,13 +22,15 @@ Function that checks queries.
 
 ### Type Parameters
 
-• **T** *extends* `object`
+• **T**
 
 • **Q** *extends* [`Query`](../type-aliases/Query.md)\<`T`\>
 
 ### Parameters
 
-• **query**: `Q` & `object`
+#### query
+
+`Q` & `object`
 
 ### Returns
 
@@ -44,7 +46,9 @@ Function that checks queries.
 
 ### Parameters
 
-• **query**: `Q` & `object`
+#### query
+
+`Q` & `object`
 
 ### Returns
 
@@ -52,4 +56,4 @@ Function that checks queries.
 
 ## Defined in
 
-[lib/tools/defineCheckQuery.ts:8](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/defineCheckQuery.ts#L8)
+[lib/tools/defineCheckQuery.ts:8](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/defineCheckQuery.ts#L8)

package/doc/functions/defineCustomFetch.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -16,7 +16,9 @@ Returns a custom fetch function that handles a `query`
 
 ## Parameters
 
-• **handler**: [`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
+### handler
+
+[`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
 
 The query handler.
 
@@ -36,7 +38,9 @@ A custom fetch function.
 
 ### Parameters
 
-• **query**: `Q` & `object`
+#### query
+
+`Q` & `object`
 
 ### Returns
 
@@ -44,15 +48,19 @@ A custom fetch function.
 
 ### Type Parameters
 
-• **T** *extends* `object`
+• **T**
 
 • **Q** *extends* [`Query`](../type-aliases/Query.md)\<`T`\>
 
 ### Parameters
 
-• **type**: `T`[]
+#### type
+
+`T`[]
+
+#### query
 
-• **query**: `Q`
+`Q`
 
 ### Returns
 
@@ -60,4 +68,4 @@ A custom fetch function.
 
 ## Defined in
 
-[lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/defineCustomFetch.ts#L11)
+[lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/defineCustomFetch.ts#L11)

package/doc/functions/defineGenericFetch.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -19,7 +19,9 @@ genericFetch<T>()(query)
 
 ## Parameters
 
-• **handler**: [`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
+### handler
+
+[`Handler`](../type-aliases/Handler.md)\<[`Query`](../type-aliases/Query.md)\<`any`\> & `object`, `any`, `never`, `never`\>
 
 The query handler.
 
@@ -31,7 +33,7 @@ A curried generic fetch function.
 
 ### Type Parameters
 
-• **T** *extends* `object`
+• **T**
 
 ### Returns
 
@@ -43,7 +45,9 @@ A curried generic fetch function.
 
 #### Parameters
 
-• **query**: `Q` & `object`
+##### query
+
+`Q` & `object`
 
 #### Returns
 
@@ -51,4 +55,4 @@ A curried generic fetch function.
 
 ## Defined in
 
-[lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/defineGenericFetch.ts#L14)
+[lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/defineGenericFetch.ts#L14)

package/doc/functions/escapeRegex.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -12,7 +12,9 @@ Escapes special characters of a given regular expresion `pattern`.
 
 ## Parameters
 
-• **pattern**: `string`
+### pattern
+
+`string`
 
 Regular expression string to escape.
 
@@ -24,4 +26,4 @@ Escaped regular expression
 
 ## Defined in
 
-[lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/tools/escapeRegex.ts#L7)
+[lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/tools/escapeRegex.ts#L7)

package/doc/functions/fetchExternal.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -12,7 +12,9 @@ Calls the provided `fetch` function, which defaults to the DOM `fetch` function,
 
 ## Parameters
 
-• **fetch** = `...`
+### fetch
+
+(`input`, `init`?) => `Promise`\<`Response`\>(`input`, `init`?) => `Promise`\<`Response`\>
 
 A standard `fetch` function.
 
@@ -24,4 +26,4 @@ Handler that returns a promise that resolves to the response.
 
 ## Defined in
 
-[lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/fetchExternal.ts#L12)
+[lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/fetchExternal.ts#L12)

package/doc/functions/fetchLocal.md

@@ -1,4 +1,4 @@
-[**quetch**](../README.md) • **Docs**
+[**quetch**](../README.md)
 
 ***
 
@@ -12,7 +12,7 @@ Performs the fetch query on local data.
 
 ## Type Parameters
 
-• **T** *extends* `object`
+• **T**
 
 ## Returns
 
@@ -22,4 +22,4 @@ Promise that resolves to the response.
 
 ## Defined in
 
-[lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/4c3c4d08a348f3317d0dfdffa7516132c18306c7/lib/middlewares/fetchLocal.ts#L9)
+[lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/daab7d5db71d61e74901886a2473b07ec4e9fc05/lib/middlewares/fetchLocal.ts#L9)

package/doc/functions/fieldListFromFilter.md

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

package/doc/functions/filterChildren.md

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