@breautek/storm 5.0.1 → 6.0.1

package/docs/interfaces/IConfig.md

@@ -1,112 +0,0 @@
-[@breautek/storm](../README.md) / IConfig
-
-# Interface: IConfig
-
-## Table of contents
-
-### Properties
-
-- [authentication\_header](IConfig.md#authentication_header)
-- [backend\_authentication\_header](IConfig.md#backend_authentication_header)
-- [backend\_authentication\_secret](IConfig.md#backend_authentication_secret)
-- [bind](IConfig.md#bind)
-- [database](IConfig.md#database)
-- [log](IConfig.md#log)
-- [port](IConfig.md#port)
-- [request\_size\_limit](IConfig.md#request_size_limit)
-
-## Properties
-
-### authentication\_header
-
-• `Optional` **authentication\_header**: `string`
-
-#### Defined in
-
-[src/IConfig.ts:26](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L26)
-
-___
-
-### backend\_authentication\_header
-
-• `Optional` **backend\_authentication\_header**: `string`
-
-#### Defined in
-
-[src/IConfig.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L27)
-
-___
-
-### backend\_authentication\_secret
-
-• `Optional` **backend\_authentication\_secret**: `string`
-
-#### Defined in
-
-[src/IConfig.ts:28](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L28)
-
-___
-
-### bind
-
-• `Optional` **bind**: `string`
-
-#### Defined in
-
-[src/IConfig.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L22)
-
-___
-
-### database
-
-• `Optional` **database**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `main?` | [`IDatabaseConfig`](IDatabaseConfig.md)<``"MASTER"``\> |
-| `query_timeout?` | `number` |
-| `replicationNodes?` | [`IDatabaseConfig`](IDatabaseConfig.md)<`string`\>[] |
-
-#### Defined in
-
-[src/IConfig.ts:38](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L38)
-
-___
-
-### log
-
-• `Optional` **log**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `directory?` | `string` |
-| `filters?` | `string`[] |
-| `level?` | `LogLevel` |
-
-#### Defined in
-
-[src/IConfig.ts:31](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L31)
-
-___
-
-### port
-
-• `Optional` **port**: `number`
-
-#### Defined in
-
-[src/IConfig.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L23)
-
-___
-
-### request\_size\_limit
-
-• `Optional` **request\_size\_limit**: `number`
-
-#### Defined in
-
-[src/IConfig.ts:45](https://github.com/breautek/storm/blob/3dcafe4/src/IConfig.ts#L45)

package/docs/interfaces/IDatabaseConfig.md

@@ -1,80 +0,0 @@
-[@breautek/storm](../README.md) / IDatabaseConfig
-
-# Interface: IDatabaseConfig<TName\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TName` | `string` |
-
-## Table of contents
-
-### Properties
-
-- [database](IDatabaseConfig.md#database)
-- [host](IDatabaseConfig.md#host)
-- [name](IDatabaseConfig.md#name)
-- [password](IDatabaseConfig.md#password)
-- [port](IDatabaseConfig.md#port)
-- [user](IDatabaseConfig.md#user)
-
-## Properties
-
-### database
-
-• **database**: `string`
-
-#### Defined in
-
-[src/IDatabaseConfig.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConfig.ts#L21)
-
-___
-
-### host
-
-• **host**: `string`
-
-#### Defined in
-
-[src/IDatabaseConfig.ts:19](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConfig.ts#L19)
-
-___
-
-### name
-
-• **name**: `TName`
-
-#### Defined in
-
-[src/IDatabaseConfig.ts:18](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConfig.ts#L18)
-
-___
-
-### password
-
-• **password**: `string`
-
-#### Defined in
-
-[src/IDatabaseConfig.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConfig.ts#L23)
-
-___
-
-### port
-
-• **port**: `number`
-
-#### Defined in
-
-[src/IDatabaseConfig.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConfig.ts#L20)
-
-___
-
-### user
-
-• **user**: `string`
-
-#### Defined in
-
-[src/IDatabaseConfig.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConfig.ts#L22)

package/docs/interfaces/IDatabaseConnection.md

@@ -1,262 +0,0 @@
-[@breautek/storm](../README.md) / IDatabaseConnection
-
-# Interface: IDatabaseConnection
-
-## Implemented by
-
-- [`DatabaseConnection`](../classes/DatabaseConnection.md)
-- [`ManagedDatabaseConnection`](../classes/ManagedDatabaseConnection.md)
-
-## Table of contents
-
-### Methods
-
-- [close](IDatabaseConnection.md#close)
-- [commit](IDatabaseConnection.md#commit)
-- [getAPI](IDatabaseConnection.md#getapi)
-- [getInstantiationStack](IDatabaseConnection.md#getinstantiationstack)
-- [getTimeout](IDatabaseConnection.md#gettimeout)
-- [isClosed](IDatabaseConnection.md#isclosed)
-- [isReadOnly](IDatabaseConnection.md#isreadonly)
-- [isTransaction](IDatabaseConnection.md#istransaction)
-- [query](IDatabaseConnection.md#query)
-- [rollback](IDatabaseConnection.md#rollback)
-- [setInstantiationStack](IDatabaseConnection.md#setinstantiationstack)
-- [setTimeout](IDatabaseConnection.md#settimeout)
-- [startTransaction](IDatabaseConnection.md#starttransaction)
-- [stream](IDatabaseConnection.md#stream)
-
-## Methods
-
-### close
-
-▸ **close**(`forceClose?`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `forceClose?` | `boolean` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:30](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L30)
-
-___
-
-### commit
-
-▸ **commit**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:34](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L34)
-
-___
-
-### getAPI
-
-▸ **getAPI**(): `any`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L24)
-
-___
-
-### getInstantiationStack
-
-▸ **getInstantiationStack**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L23)
-
-___
-
-### getTimeout
-
-▸ **getTimeout**(): `number`
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L27)
-
-___
-
-### isClosed
-
-▸ **isClosed**(): `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:31](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L31)
-
-___
-
-### isReadOnly
-
-▸ **isReadOnly**(): `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L25)
-
-___
-
-### isTransaction
-
-▸ **isTransaction**(): `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:33](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L33)
-
-___
-
-### query
-
-▸ **query**(`query`, `params?`): `Promise`<`any`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | [`IQueryable`](IQueryable.md)<`any`\> |
-| `params?` | `any` |
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:28](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L28)
-
-___
-
-### rollback
-
-▸ **rollback**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:35](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L35)
-
-___
-
-### setInstantiationStack
-
-▸ **setInstantiationStack**(`stack`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `stack` | `string` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L22)
-
-___
-
-### setTimeout
-
-▸ **setTimeout**(`timeout`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `timeout` | `number` |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:26](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L26)
-
-___
-
-### startTransaction
-
-▸ **startTransaction**(`level?`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `level?` | [`IsolationLevel`](../enums/IsolationLevel.md) |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:32](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L32)
-
-___
-
-### stream
-
-▸ **stream**(`query`, `params?`, `streamOptions?`): `Readable`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | [`IQueryable`](IQueryable.md)<`any`\> |
-| `params?` | `any` |
-| `streamOptions?` | `any` |
-
-#### Returns
-
-`Readable`
-
-#### Defined in
-
-[src/IDatabaseConnection.ts:29](https://github.com/breautek/storm/blob/3dcafe4/src/IDatabaseConnection.ts#L29)

package/docs/interfaces/IErrorResponse.md

@@ -1,63 +0,0 @@
-[@breautek/storm](../README.md) / IErrorResponse
-
-# Interface: IErrorResponse
-
-## Table of contents
-
-### Properties
-
-- [code](IErrorResponse.md#code)
-- [details](IErrorResponse.md#details)
-- [locale](IErrorResponse.md#locale)
-- [message](IErrorResponse.md#message)
-- [name](IErrorResponse.md#name)
-
-## Properties
-
-### code
-
-• **code**: `number`
-
-#### Defined in
-
-[src/StormError.ts:37](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L37)
-
-___
-
-### details
-
-• **details**: [`IAdditionalErrorDetails`](IAdditionalErrorDetails.md)
-
-#### Defined in
-
-[src/StormError.ts:38](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L38)
-
-___
-
-### locale
-
-• **locale**: `ILocale`
-
-#### Defined in
-
-[src/StormError.ts:36](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L36)
-
-___
-
-### message
-
-• **message**: `string`
-
-#### Defined in
-
-[src/StormError.ts:35](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L35)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[src/StormError.ts:34](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L34)

package/docs/interfaces/IFormData.md

@@ -1,30 +0,0 @@
-[@breautek/storm](../README.md) / IFormData
-
-# Interface: IFormData
-
-## Table of contents
-
-### Properties
-
-- [fields](IFormData.md#fields)
-- [files](IFormData.md#files)
-
-## Properties
-
-### fields
-
-• **fields**: [`Fields`](formidable.Fields.md)
-
-#### Defined in
-
-[src/IFormData.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/IFormData.ts#L20)
-
-___
-
-### files
-
-• **files**: [`Files`](formidable.Files.md)
-
-#### Defined in
-
-[src/IFormData.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/IFormData.ts#L21)

package/docs/interfaces/IHandler.md

@@ -1,31 +0,0 @@
-[@breautek/storm](../README.md) / IHandler
-
-# Interface: IHandler<TApplication\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TApplication` | extends [`Application`](../classes/Application.md) = [`Application`](../classes/Application.md) |
-
-## Table of contents
-
-### Constructors
-
-- [constructor](IHandler.md#constructor)
-
-## Constructors
-
-### constructor
-
-• **new IHandler**(`app`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `app` | `TApplication` |
-
-#### Defined in
-
-[src/IHandler.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/IHandler.ts#L21)

package/docs/interfaces/IInsertQueryResult.md

@@ -1,41 +0,0 @@
-[@breautek/storm](../README.md) / IInsertQueryResult
-
-# Interface: IInsertQueryResult
-
-## Table of contents
-
-### Properties
-
-- [affectedRows](IInsertQueryResult.md#affectedrows)
-- [changedRows](IInsertQueryResult.md#changedrows)
-- [insertId](IInsertQueryResult.md#insertid)
-
-## Properties
-
-### affectedRows
-
-• **affectedRows**: `number`
-
-#### Defined in
-
-[src/IInsertQueryResult.ts:19](https://github.com/breautek/storm/blob/3dcafe4/src/IInsertQueryResult.ts#L19)
-
-___
-
-### changedRows
-
-• **changedRows**: `number`
-
-#### Defined in
-
-[src/IInsertQueryResult.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/IInsertQueryResult.ts#L20)
-
-___
-
-### insertId
-
-• **insertId**: `number`
-
-#### Defined in
-
-[src/IInsertQueryResult.ts:18](https://github.com/breautek/storm/blob/3dcafe4/src/IInsertQueryResult.ts#L18)

package/docs/interfaces/IJWTVerifyOptions.md

@@ -1,19 +0,0 @@
-[@breautek/storm](../README.md) / IJWTVerifyOptions
-
-# Interface: IJWTVerifyOptions
-
-## Table of contents
-
-### Properties
-
-- [enableExpiration](IJWTVerifyOptions.md#enableexpiration)
-
-## Properties
-
-### enableExpiration
-
-• **enableExpiration**: `boolean`
-
-#### Defined in
-
-[src/IJWTVerifyOptions.ts:18](https://github.com/breautek/storm/blob/3dcafe4/src/IJWTVerifyOptions.ts#L18)

package/docs/interfaces/IParameterMap.md

@@ -1,7 +0,0 @@
-[@breautek/storm](../README.md) / IParameterMap
-
-# Interface: IParameterMap
-
-## Indexable
-
-▪ [key: `string`]: `string`