quetch 0.14.0 → 0.16.0

package/doc/type-aliases/FieldFunctionCustom.md

@@ -0,0 +1,37 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FieldFunctionCustom
+
+# Type Alias: FieldFunctionCustom\<T\>
+
+> **FieldFunctionCustom**\<`T`\>: `object`
+
+Applies a custom field transform function.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### operator
+
+> **operator**: `"custom"`
+
+### value()
+
+> **value**: (`item`) => `any`
+
+#### Parameters
+
+• **item**: `T`
+
+#### Returns
+
+`any`
+
+## Defined in
+
+[lib/types/FieldFunctionCustom.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FieldFunctionCustom.ts#L4)

package/doc/type-aliases/FieldFunctionFormatDate.md

@@ -0,0 +1,33 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FieldFunctionFormatDate
+
+# Type Alias: FieldFunctionFormatDate\<T\>
+
+> **FieldFunctionFormatDate**\<`T`\>: `object`
+
+Formats the date found in a given field, which can be an ISO string date or a timestamp.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### field
+
+> **field**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `string` \| `number`\>
+
+### format
+
+> **format**: `string`
+
+### operator
+
+> **operator**: `"formatDate"`
+
+## Defined in
+
+[lib/types/FieldFunctionFormatDate.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FieldFunctionFormatDate.ts#L6)

package/doc/type-aliases/FieldFunctionReturn.md

@@ -0,0 +1,21 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FieldFunctionReturn
+
+# Type Alias: FieldFunctionReturn
+
+> **FieldFunctionReturn**: `object`
+
+Return types of custom field functions.
+
+## Type declaration
+
+### formatDate
+
+> **formatDate**: `string`
+
+## Defined in
+
+[lib/types/FieldFunctionReturn.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FieldFunctionReturn.ts#L4)

package/doc/type-aliases/Filter.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Filter
+
+# Type Alias: Filter\<T\>
+
+> **Filter**\<`T`\>: [`FilterArray`](FilterArray.md)\<`T`\> \| [`FilterBoolean`](FilterBoolean.md)\<`T`\> \| [`FilterChildren`](FilterChildren.md)\<`T`\> \| [`FilterCustom`](FilterCustom.md)\<`T`\> \| [`FilterField`](FilterField.md)\<`T`\> \| [`FilterNumber`](FilterNumber.md)\<`T`\> \| [`FilterGroup`](FilterGroup.md)\<`T`\> \| [`FilterString`](FilterString.md)\<`T`\> \| [`FilterStringIntersect`](FilterStringIntersect.md)\<`T`\> \| [`FilterStringMatch`](FilterStringMatch.md)\<`T`\>
+
+Describes a predicate for filtering items.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/Filter.ts:15](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Filter.ts#L15)

package/doc/type-aliases/FilterArray.md

@@ -0,0 +1,31 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterArray
+
+# Type Alias: FilterArray\<T, P\>
+
+> **FilterArray**\<`T`, `P`\>: `object` & [`Value`](Value.md)\<`T`, `P`[]\>
+
+Checks if a given array field matches a given array value according to a given operator.
+
+## Type declaration
+
+### field
+
+> **field**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `P`[]\>
+
+### operator
+
+> **operator**: `"equal"` \| `"include"` \| `"intersect"`
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+• **P** = [`Any`](Any.md)
+
+## Defined in
+
+[lib/types/FilterArray.ts:8](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterArray.ts#L8)

package/doc/type-aliases/FilterBoolean.md

@@ -0,0 +1,29 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterBoolean
+
+# Type Alias: FilterBoolean\<T\>
+
+> **FilterBoolean**\<`T`\>: `object` & [`Value`](Value.md)\<`T`, `boolean`\>
+
+Checks if a given boolean field is `true` or `false`.
+
+## Type declaration
+
+### field
+
+> **field**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `boolean`\>
+
+### operator
+
+> **operator**: `"equal"` \| `"notEqual"`
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/FilterBoolean.ts:7](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterBoolean.ts#L7)

package/doc/type-aliases/FilterChildren.md

@@ -0,0 +1,38 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterChildren
+
+# Type Alias: FilterChildren\<T\>
+
+> **FilterChildren**\<`T`\>: `object`
+
+Matches the direct children of a specified `value` item.
+If `deep` is `true`, also captures all the descendants.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### \[SymbolCache\]?
+
+> `optional` **\[SymbolCache\]**: [`Filter`](Filter.md)\<`T`\>
+
+### deep?
+
+> `optional` **deep**: `boolean`
+
+### operator
+
+> **operator**: `"children"`
+
+### value?
+
+> `optional` **value**: [`Context`](Context.md)\<`T`\> \| `string`
+
+## Defined in
+
+[lib/types/FilterChildren.ts:10](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterChildren.ts#L10)

package/doc/type-aliases/FilterCustom.md

@@ -0,0 +1,37 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterCustom
+
+# Type Alias: FilterCustom\<T\>
+
+> **FilterCustom**\<`T`\>: `object`
+
+Custom filter where `value(item)` returns `true` for matching items.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### operator
+
+> **operator**: `"custom"`
+
+### value()
+
+> **value**: (`item`) => `boolean`
+
+#### Parameters
+
+• **item**: `T`
+
+#### Returns
+
+`boolean`
+
+## Defined in
+
+[lib/types/FilterCustom.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterCustom.ts#L4)

package/doc/type-aliases/FilterField.md

@@ -0,0 +1,31 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterField
+
+# Type Alias: FilterField\<T\>
+
+> **FilterField**\<`T`\>: `object`
+
+Checks if a given field exists.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### field
+
+> **field**: [`Field`](Field.md)\<`T`\>
+
+The field name or path for which to check its existence.
+
+### operator
+
+> **operator**: `"exist"`
+
+## Defined in
+
+[lib/types/FilterField.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterField.ts#L6)

package/doc/type-aliases/FilterGroup.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterGroup
+
+# Type Alias: FilterGroup\<T\>
+
+> **FilterGroup**\<`T`\>: `object` \| `object`
+
+Joins a list of filters with a specific boolean operator.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/FilterGroup.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterGroup.ts#L6)

package/doc/type-aliases/FilterNumber.md

@@ -0,0 +1,29 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterNumber
+
+# Type Alias: FilterNumber\<T\>
+
+> **FilterNumber**\<`T`\>: `object` & [`Value`](Value.md)\<`T`, `number`\>
+
+Checks if a given number field matches a given number value according to a given operator.
+
+## Type declaration
+
+### field
+
+> **field**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `number`\>
+
+### operator
+
+> **operator**: `"equal"` \| `"notEqual"` \| `"greaterThan"` \| `"greaterThanOrEqual"` \| `"lowerThan"` \| `"lowerThanOrEqual"`
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/FilterNumber.ts:7](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterNumber.ts#L7)

package/doc/type-aliases/FilterOperator.md

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

package/doc/type-aliases/FilterString.md

@@ -0,0 +1,37 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterString
+
+# Type Alias: FilterString\<T\>
+
+> **FilterString**\<`T`\>: `object` & [`Value`](Value.md)\<`T`, `string`\>
+
+Checks if a given string field matches a given string value according to a given operator.
+
+## Type declaration
+
+### field
+
+> **field**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `string`\>
+
+### locale?
+
+> `optional` **locale**: [`Locale`](Locale.md)
+
+### operator
+
+> **operator**: `"equal"` \| `"notEqual"` \| `"startWith"` \| `"endWith"` \| `"include"` \| `"greaterThan"` \| `"greaterThanOrEqual"` \| `"lowerThan"` \| `"lowerThanOrEqual"`
+
+### options?
+
+> `optional` **options**: `Intl.CollatorOptions`
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/FilterString.ts:8](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterString.ts#L8)

package/doc/type-aliases/FilterStringIntersect.md

@@ -0,0 +1,37 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterStringIntersect
+
+# Type Alias: FilterStringIntersect\<T\>
+
+> **FilterStringIntersect**\<`T`\>: `object` & [`Value`](Value.md)\<`T`, `string`[]\>
+
+Checks if a given string field has any of the provided values.
+
+## Type declaration
+
+### field
+
+> **field**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `string`\>
+
+### locale?
+
+> `optional` **locale**: [`Locale`](Locale.md)
+
+### operator
+
+> **operator**: `"intersect"`
+
+### options?
+
+> `optional` **options**: `Intl.CollatorOptions`
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/FilterStringIntersect.ts:8](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterStringIntersect.ts#L8)

package/doc/type-aliases/FilterStringMatch.md

@@ -0,0 +1,53 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / FilterStringMatch
+
+# Type Alias: FilterStringMatch\<T\>
+
+> **FilterStringMatch**\<`T`\>: `object` & [`Value`](Value.md)\<`T`, `string`\>
+
+Checks if a given string field matches a given regular expression, the value being a raw regular expression string.
+
+## Type declaration
+
+### \[SymbolCache\]?
+
+> `optional` **\[SymbolCache\]**: `RegExp`
+
+Compiled regular expression generated by the `testFilter` function.
+
+### field
+
+> **field**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `string`\>
+
+### operator
+
+> **operator**: `"match"`
+
+### options?
+
+> `optional` **options**: `object`
+
+Regular expression options.
+
+### options.dotAll?
+
+> `optional` **dotAll**: `boolean`
+
+Allow `.` to match newlines.
+
+### options.ignoreCase?
+
+> `optional` **ignoreCase**: `boolean`
+
+Ignore casing differences if `true`.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/FilterStringMatch.ts:9](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/FilterStringMatch.ts#L9)

package/doc/type-aliases/Get.md

@@ -0,0 +1,21 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Get
+
+# Type Alias: Get\<T, P\>
+
+> **Get**\<`T`, `P`\>: [`P`] *extends* [[infer K, `...(infer R)`]] ? `K` *extends* keyof `T` ? `R` *extends* [`Path`](Path.md)\<`T`\[`K`\]\> ? [`Get`](Get.md)\<`T`\[`K`\], `R`\> : `T`\[`K`\] : `never` : [`P`] *extends* [keyof `T`] ? `T`\[`P`\] : `T`
+
+Returns the type of the property at the specified `P` path.
+
+## Type Parameters
+
+• **T**
+
+• **P**
+
+## Defined in
+
+[lib/types/Get.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Get.ts#L6)

package/doc/type-aliases/Group.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Group
+
+# Type Alias: Group\<T\>
+
+> **Group**\<`T`\>: keyof `T` \| `object`
+
+Specifies how items should be grouped.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/Group.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Group.ts#L4)

package/doc/type-aliases/Handler.md

@@ -0,0 +1,35 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Handler
+
+# Type Alias: Handler()\<I, O, NI, No\>
+
+> **Handler**\<`I`, `O`, `NI`, `No`\>: (`input`, `next`) => `Promise`\<`O`\>
+
+Handles an `input` query and returns an `output` promise, eventually using the `next` handler.
+
+## Type Parameters
+
+• **I**
+
+• **O**
+
+• **NI**
+
+• **No**
+
+## Parameters
+
+• **input**: `I`
+
+• **next**: [`NextHandler`](NextHandler.md)\<`NI`, `No`\>
+
+## Returns
+
+`Promise`\<`O`\>
+
+## Defined in
+
+[lib/types/Handler.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Handler.ts#L6)

package/doc/type-aliases/Immutable.md

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

package/doc/type-aliases/Increment.md

@@ -0,0 +1,17 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Increment
+
+# Type Alias: Increment\<D\>
+
+> **Increment**\<`D`\>: `D` *extends* `Digit` ? `NextDigit`\[`D`\] : `-1`
+
+## Type Parameters
+
+• **D**
+
+## Defined in
+
+[lib/types/Increment.ts:5](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Increment.ts#L5)

package/doc/type-aliases/InjectCustomFields.md

@@ -0,0 +1,21 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / InjectCustomFields
+
+# Type Alias: InjectCustomFields\<T, C\>
+
+> **InjectCustomFields**\<`T`, `C`\>: `C` *extends* [`CustomFieldMap`](CustomFieldMap.md)\<`T`\> ? \{ readonly \[K in keyof T \| keyof C\]: K extends keyof T ? T\[K\] : K extends keyof C ? C\[K\] extends FieldFunctionCustom\<T\> ? ReturnType\<C\[K\]\["value"\]\> : C\[K\]\["operator"\] extends keyof FieldFunctionReturn ? FieldFunctionReturn\[C\[K\]\["operator"\]\] : never : never \} : `T`
+
+Injects the custom fields into the entity type.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+• **C** *extends* [`CustomFieldMap`](CustomFieldMap.md)\<`T`\> \| `undefined`
+
+## Defined in
+
+[lib/types/InjectCustomFields.ts:8](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/InjectCustomFields.ts#L8)

package/doc/type-aliases/Item.md

@@ -0,0 +1,21 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Item
+
+# Type Alias: Item\<T, S\>
+
+> **Item**\<`T`, `S`\>: `T` *extends* infer I[] ? `I` : `T` *extends* `ReadonlyArray`\<infer I\> ? `I` : `S`
+
+Returns the inferred item type of an array, or an alternative type if it is something else (e.g., `undefined`).
+
+## Type Parameters
+
+• **T**
+
+• **S** = `undefined`
+
+## Defined in
+
+[lib/types/Item.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Item.ts#L4)

package/doc/type-aliases/Join.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Join
+
+# Type Alias: Join\<T, Separator\>
+
+> **Join**\<`T`, `Separator`\>: `T` *extends* readonly [infer I, `...(infer R)`] ? `I` *extends* `string` \| `number` ? `R` *extends* [] ? `I` : `R` *extends* `string`[] ? \`$\{I\}$\{Separator\}$\{Join\<R, Separator\>\}\` : `never` : `never` : `never`
+
+## Type Parameters
+
+• **T** *extends* `any`[]
+
+• **Separator** *extends* `string` = `"."`
+
+## Defined in
+
+[lib/types/Join.ts:1](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Join.ts#L1)

package/doc/type-aliases/Key.md

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