quetch 0.14.0 → 0.16.0

package/doc/type-aliases/KeyFiltered.md

@@ -0,0 +1,21 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / KeyFiltered
+
+# Type Alias: KeyFiltered\<T, P\>
+
+> **KeyFiltered**\<`T`, `P`\>: keyof `T` & keyof `{ [K in keyof T as T[K] extends P ? K : never]-?: T[K] }`
+
+Returns object type with field extending the provided `P` type.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+• **P**
+
+## Defined in
+
+[lib/types/KeyFiltered.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/KeyFiltered.ts#L4)

package/doc/type-aliases/Locale.md

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

package/doc/type-aliases/Mutable.md

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

package/doc/type-aliases/NextHandler.md

@@ -0,0 +1,29 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / NextHandler
+
+# Type Alias: NextHandler()\<I, R\>
+
+> **NextHandler**\<`I`, `R`\>: (`input`) => `Promise`\<`R`\>
+
+Handles an `input` query and returns an `output` promise.
+
+## Type Parameters
+
+• **I**
+
+• **R**
+
+## Parameters
+
+• **input**: `I`
+
+## Returns
+
+`Promise`\<`R`\>
+
+## Defined in
+
+[lib/types/NextHandler.ts:4](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/NextHandler.ts#L4)

package/doc/type-aliases/Order.md

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

package/doc/type-aliases/Parameters.md

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

package/doc/type-aliases/Path.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Path
+
+# Type Alias: Path\<T, D\>
+
+> **Path**\<`T`, `D`\>: `D` *extends* `4` ? `never` : `T` *extends* infer P[] ? [`number`] \| [`number`, `...Path<P, Increment<D>>`] : `T` *extends* `object` ? \{ \[K in keyof T\]-?: \[K\] \| \[K, ...Path\<T\[K\], Increment\<D\>\>\] \}\[keyof `T`\] : `never`
+
+## Type Parameters
+
+• **T**
+
+• **D** = `0`
+
+## Defined in
+
+[lib/types/Path.ts:3](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Path.ts#L3)

package/doc/type-aliases/PathFiltered.md

@@ -0,0 +1,21 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / PathFiltered
+
+# Type Alias: PathFiltered\<T, P, D\>
+
+> **PathFiltered**\<`T`, `P`, `D`\>: `D` *extends* `4` ? `never` : `T` *extends* infer I[] ? `I` *extends* `P` ? [`number`] : [`number`, `...PathFiltered<I, P, Increment<D>>`] : `T` *extends* `object` ? `{ [K in keyof T]-?: T[K] extends P ? [K] : [K, ...PathFiltered<T[K], P, Increment<D>>] }`\[keyof `T`\] : `never`
+
+## Type Parameters
+
+• **T**
+
+• **P**
+
+• **D** = `0`
+
+## Defined in
+
+[lib/types/PathFiltered.ts:3](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/PathFiltered.ts#L3)

package/doc/type-aliases/Query.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Query
+
+# Type Alias: Query\<T\>
+
+> **Query**\<`T`\>: [`QueryRead`](QueryRead.md)\<`T`\> \| [`QueryReadMultiple`](QueryReadMultiple.md)\<`T`\> \| [`QueryCreate`](QueryCreate.md)\<`T`\> \| [`QueryCreateMultiple`](QueryCreateMultiple.md)\<`T`\> \| [`QueryUpdate`](QueryUpdate.md)\<`T`\> \| [`QueryUpdateMultiple`](QueryUpdateMultiple.md)\<`T`\> \| [`QueryDelete`](QueryDelete.md)\<`T`\> \| [`QueryDeleteMultiple`](QueryDeleteMultiple.md)\<`T`\> \| [`QueryAggregate`](QueryAggregate.md)\<`T`\>
+
+Query that fetches or mutates an entity.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Defined in
+
+[lib/types/Query.ts:14](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Query.ts#L14)

package/doc/type-aliases/QueryAggregate.md

@@ -0,0 +1,71 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryAggregate
+
+# Type Alias: QueryAggregate\<T\>
+
+> **QueryAggregate**\<`T`\>: `object`
+
+Query for computing an aggregated value.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### aggregator
+
+> **aggregator**: [`AggregateFunction`](AggregateFunction.md)\<`T`\>
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the item.
+
+### filter?
+
+> `optional` **filter**: [`Filter`](Filter.md)\<`T`\>
+
+Filter that picks the items.
+
+### limit?
+
+> `optional` **limit**: `number`
+
+Upper bound of the number of items to return.
+
+### method
+
+> **method**: `"aggregate"`
+
+### offset?
+
+> `optional` **offset**: `number`
+
+Offset of the first matching item.
+
+### order?
+
+> `optional` **order**: [`Order`](Order.md)\<`T`\>[]
+
+Order by which the items should be sorted.
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+## Defined in
+
+[lib/types/QueryAggregate.ts:11](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryAggregate.ts#L11)

package/doc/type-aliases/QueryCreate.md

@@ -0,0 +1,53 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryCreate
+
+# Type Alias: QueryCreate\<T\>
+
+> **QueryCreate**\<`T`\>: `object`
+
+Query for creating an item.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the context in which to create the item.
+
+### method
+
+> **method**: `"create"`
+
+### multiple?
+
+> `optional` **multiple**: `false`
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+### value
+
+> **value**: `Partial`\<`T`\>
+
+Value properties of the item to create.
+
+## Defined in
+
+[lib/types/QueryCreate.ts:8](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryCreate.ts#L8)

package/doc/type-aliases/QueryCreateMultiple.md

@@ -0,0 +1,51 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryCreateMultiple
+
+# Type Alias: QueryCreateMultiple\<T\>
+
+> **QueryCreateMultiple**\<`T`\>: `object`
+
+Query for creating multiple items.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the context in which to create the items.
+
+### method
+
+> **method**: `"create"`
+
+### multiple
+
+> **multiple**: `true`
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+### value
+
+> **value**: `Partial`\<`T`\>[]
+
+## Defined in
+
+[lib/types/QueryCreateMultiple.ts:8](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryCreateMultiple.ts#L8)

package/doc/type-aliases/QueryDelete.md

@@ -0,0 +1,51 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryDelete
+
+# Type Alias: QueryDelete\<T\>
+
+> **QueryDelete**\<`T`\>: `object`
+
+Query for deleting an item.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the context in which to delete the item.
+
+### filter?
+
+> `optional` **filter**: [`Filter`](Filter.md)\<`T`\>
+
+### method
+
+> **method**: `"delete"`
+
+### multiple?
+
+> `optional` **multiple**: `false`
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+## Defined in
+
+[lib/types/QueryDelete.ts:9](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryDelete.ts#L9)

package/doc/type-aliases/QueryDeleteMultiple.md

@@ -0,0 +1,51 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryDeleteMultiple
+
+# Type Alias: QueryDeleteMultiple\<T\>
+
+> **QueryDeleteMultiple**\<`T`\>: `object`
+
+Query for deleting multiple items.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the context in which to delete the item.
+
+### filter?
+
+> `optional` **filter**: [`Filter`](Filter.md)\<`T`\>
+
+### method
+
+> **method**: `"delete"`
+
+### multiple
+
+> **multiple**: `true`
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+## Defined in
+
+[lib/types/QueryDeleteMultiple.ts:9](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryDeleteMultiple.ts#L9)

package/doc/type-aliases/QueryMethod.md

@@ -0,0 +1,15 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryMethod
+
+# Type Alias: QueryMethod
+
+> **QueryMethod**: `Exclude`\<[`Query`](Query.md)\<`never`\>\[`"method"`\], `undefined`\>
+
+Available query methods.
+
+## Defined in
+
+[lib/types/QueryMethod.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryMethod.ts#L6)

package/doc/type-aliases/QueryRead.md

@@ -0,0 +1,79 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryRead
+
+# Type Alias: QueryRead\<T\>
+
+> **QueryRead**\<`T`\>: `object`
+
+Query for reading a single item.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the context in which to get the item.
+
+### fields?
+
+> `optional` **fields**: readonly keyof `T`[]
+
+Item fields to pick. If omitted, all fields are picked.
+
+### filter?
+
+> `optional` **filter**: [`Filter`](Filter.md)\<`T`\>
+
+Filter for finding the item, if it cannot be found based on the `context`.
+
+### group?
+
+> `optional` **group**: `never`
+
+### limit?
+
+> `optional` **limit**: `never`
+
+### method?
+
+> `optional` **method**: `"read"`
+
+### multiple?
+
+> `optional` **multiple**: `false`
+
+### offset?
+
+> `optional` **offset**: `number`
+
+Offset of the first matching item.
+
+### order?
+
+> `optional` **order**: [`Order`](Order.md)\<`T`\>[]
+
+Order by which the items should be sorted.
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+## Defined in
+
+[lib/types/QueryRead.ts:10](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryRead.ts#L10)

package/doc/type-aliases/QueryReadMultiple.md

@@ -0,0 +1,83 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryReadMultiple
+
+# Type Alias: QueryReadMultiple\<T\>
+
+> **QueryReadMultiple**\<`T`\>: `object`
+
+Query for getting a list of items.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the item.
+
+### fields?
+
+> `optional` **fields**: readonly keyof `T`[]
+
+Item fields to pick. If omitted, all fields are picked.
+
+### filter?
+
+> `optional` **filter**: [`Filter`](Filter.md)\<`T`\>
+
+Filter that picks the items.
+
+### group?
+
+> `optional` **group**: [`Group`](Group.md)\<`T`\>[]
+
+Groups items by specified fields.
+
+### limit?
+
+> `optional` **limit**: `number`
+
+Upper bound of the number of items to return.
+
+### method?
+
+> `optional` **method**: `"read"`
+
+### multiple
+
+> **multiple**: `true`
+
+### offset?
+
+> `optional` **offset**: `number`
+
+Offset of the first matching item.
+
+### order?
+
+> `optional` **order**: [`Order`](Order.md)\<`T`\>[]
+
+Order by which the items should be sorted.
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+## Defined in
+
+[lib/types/QueryReadMultiple.ts:11](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryReadMultiple.ts#L11)