@breautek/storm 3.3.1 → 4.1.0

package/docs/classes/{Query.Query-1.md → Query.md}

@@ -1,9 +1,7 @@
-[@breautek/storm](../README.md) / [Query](../modules/Query.md) / Query
+[@breautek/storm](../README.md) / Query
 
 # Class: Query<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet\>
 
-[Query](../modules/Query.md).Query
-
 ## Type parameters
 
 | Name | Type |
@@ -16,33 +14,29 @@
 
 - **`Query`**
 
-  ↳ [`DropTemporaryTableQuery`](DropTemporaryTableQuery.DropTemporaryTableQuery-1.md)
-
-  ↳ [`RawQuery`](RawQuery.RawQuery-1.md)
+  ↳ [`TemporaryTableQuery`](TemporaryTableQuery.md)
 
-  ↳ [`TemporaryTableQuery`](TemporaryTableQuery.TemporaryTableQuery-1.md)
+  ↳ [`DropTemporaryTableQuery`](DropTemporaryTableQuery.md)
 
-  ↳ [`CommitQuery`](private_CommitQuery.CommitQuery.md)
+  ↳ [`RawQuery`](RawQuery.md)
 
-  ↳ [`RollbackQuery`](private_RollbackQuery.RollbackQuery.md)
-
-  ↳ [`StartTransactionQuery`](private_StartTransactionQuery.StartTransactionQuery.md)
+  ↳ [`SetSessionVariableQuery`](SetSessionVariableQuery.md)
 
 ## Table of contents
 
 ### Constructors
 
-- [constructor](Query.Query-1.md#constructor)
+- [constructor](Query.md#constructor)
 
 ### Methods
 
-- [\_getQuery](Query.Query-1.md#_getquery)
-- [execute](Query.Query-1.md#execute)
-- [getParameters](Query.Query-1.md#getparameters)
-- [getParametersForQuery](Query.Query-1.md#getparametersforquery)
-- [getQuery](Query.Query-1.md#getquery)
-- [onPostProcess](Query.Query-1.md#onpostprocess)
-- [onPreQuery](Query.Query-1.md#onprequery)
+- [\_getQuery](Query.md#_getquery)
+- [execute](Query.md#execute)
+- [getParameters](Query.md#getparameters)
+- [getParametersForQuery](Query.md#getparametersforquery)
+- [getQuery](Query.md#getquery)
+- [onPostProcess](Query.md#onpostprocess)
+- [onPreQuery](Query.md#onprequery)
 
 ## Constructors
 
@@ -66,13 +60,19 @@
 
 #### Defined in
 
-[src/Query.ts:23](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L23)
+[src/Query.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L22)
 
 ## Methods
 
 ### \_getQuery
 
-▸ `Protected` `Abstract` **_getQuery**(): `string`
+▸ `Protected` `Abstract` **_getQuery**(`connection`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
 
 #### Returns
 
@@ -80,7 +80,7 @@
 
 #### Defined in
 
-[src/Query.ts:35](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L35)
+[src/Query.ts:34](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L34)
 
 ___
 
@@ -92,7 +92,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.IDatabaseConnection-1.md) |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
 
 #### Returns
 
@@ -100,7 +100,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:63](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L63)
+[src/Query.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L62)
 
 ___
 
@@ -114,27 +114,33 @@ ___
 
 #### Defined in
 
-[src/Query.ts:27](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L27)
+[src/Query.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L26)
 
 ___
 
 ### getParametersForQuery
 
-▸ **getParametersForQuery**(): `IDictionary`<`any`\>
+▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
 
 #### Returns
 
-`IDictionary`<`any`\>
+`Record`<`any`, `any`\>
 
 #### Defined in
 
-[src/Query.ts:31](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L31)
+[src/Query.ts:30](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L30)
 
 ___
 
 ### getQuery
 
-▸ **getQuery**(): `string`
+▸ **getQuery**(`connection`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
 
 #### Returns
 
@@ -142,7 +148,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:37](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L37)
+[src/Query.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L36)
 
 ___
 
@@ -156,7 +162,7 @@ Override to augment/manipulate the returned result set.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.IDatabaseConnection-1.md) | The connection object used for this query execution. Useful if further queries are required. |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) | The connection object used for this query execution. Useful if further queries are required. |
 | `resultSet` | `TQueryResultSet` | - |
 
 #### Returns
@@ -165,7 +171,7 @@ Override to augment/manipulate the returned result set.
 
 #### Defined in
 
-[src/Query.ts:58](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L58)
+[src/Query.ts:57](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L57)
 
 ___
 
@@ -180,7 +186,7 @@ Can be used to set session variables or create temporary tables, etc.
 
 | Name | Type |
 | :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.IDatabaseConnection-1.md) |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
 
 #### Returns
 
@@ -188,4 +194,4 @@ Can be used to set session variables or create temporary tables, etc.
 
 #### Defined in
 
-[src/Query.ts:48](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L48)
+[src/Query.ts:47](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L47)

package/docs/classes/RawQuery.md

@@ -0,0 +1,218 @@
+[@breautek/storm](../README.md) / RawQuery
+
+# Class: RawQuery<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TQueryParameters` | `any` |
+| `TQueryResultSet` | `any` |
+| `TQueryPostProcessedResultSet` | `TQueryResultSet` |
+
+## Hierarchy
+
+- [`Query`](Query.md)<`TQueryParameters`, `TQueryResultSet`, `TQueryPostProcessedResultSet`\>
+
+  ↳ **`RawQuery`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](RawQuery.md#constructor)
+
+### Methods
+
+- [\_getQuery](RawQuery.md#_getquery)
+- [execute](RawQuery.md#execute)
+- [getParameters](RawQuery.md#getparameters)
+- [getParametersForQuery](RawQuery.md#getparametersforquery)
+- [getQuery](RawQuery.md#getquery)
+- [onPostProcess](RawQuery.md#onpostprocess)
+- [onPreQuery](RawQuery.md#onprequery)
+
+## Constructors
+
+### constructor
+
+• **new RawQuery**<`TQueryParameters`, `TQueryResultSet`, `TQueryPostProcessedResultSet`\>(`query`, `parameters?`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TQueryParameters` | `any` |
+| `TQueryResultSet` | `any` |
+| `TQueryPostProcessedResultSet` | `TQueryResultSet` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `parameters?` | `TQueryParameters` |
+
+#### Overrides
+
+[Query](Query.md).[constructor](Query.md#constructor)
+
+#### Defined in
+
+[src/RawQuery.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/RawQuery.ts#L22)
+
+## Methods
+
+### \_getQuery
+
+▸ `Protected` **_getQuery**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[Query](Query.md).[_getQuery](Query.md#_getquery)
+
+#### Defined in
+
+[src/RawQuery.ts:27](https://github.com/breautek/storm/blob/3ad3438/src/RawQuery.ts#L27)
+
+___
+
+### execute
+
+▸ **execute**(`connection`): `Promise`<`TQueryPostProcessedResultSet`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`Promise`<`TQueryPostProcessedResultSet`\>
+
+#### Inherited from
+
+[Query](Query.md).[execute](Query.md#execute)
+
+#### Defined in
+
+[src/Query.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L62)
+
+___
+
+### getParameters
+
+▸ **getParameters**(): `TQueryParameters`
+
+#### Returns
+
+`TQueryParameters`
+
+#### Inherited from
+
+[Query](Query.md).[getParameters](Query.md#getparameters)
+
+#### Defined in
+
+[src/Query.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L26)
+
+___
+
+### getParametersForQuery
+
+▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
+
+#### Returns
+
+`Record`<`any`, `any`\>
+
+#### Inherited from
+
+[Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
+
+#### Defined in
+
+[src/Query.ts:30](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L30)
+
+___
+
+### getQuery
+
+▸ **getQuery**(`connection`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[Query](Query.md).[getQuery](Query.md#getquery)
+
+#### Defined in
+
+[src/Query.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L36)
+
+___
+
+### onPostProcess
+
+▸ **onPostProcess**(`connection`, `resultSet`): `Promise`<`TQueryPostProcessedResultSet`\>
+
+Override to augment/manipulate the returned result set.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) | The connection object used for this query execution. Useful if further queries are required. |
+| `resultSet` | `TQueryResultSet` | - |
+
+#### Returns
+
+`Promise`<`TQueryPostProcessedResultSet`\>
+
+#### Inherited from
+
+[Query](Query.md).[onPostProcess](Query.md#onpostprocess)
+
+#### Defined in
+
+[src/Query.ts:57](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L57)
+
+___
+
+### onPreQuery
+
+▸ **onPreQuery**(`connection`): `Promise`<`void`\>
+
+Overridable to execute statements before the main query.
+Can be used to set session variables or create temporary tables, etc.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[Query](Query.md).[onPreQuery](Query.md#onprequery)
+
+#### Defined in
+
+[src/Query.ts:47](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L47)

package/docs/classes/Request.md

@@ -0,0 +1,321 @@
+[@breautek/storm](../README.md) / Request
+
+# Class: Request<TBody, TAuthToken\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TBody` | `any` |
+| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Request.md#constructor)
+
+### Methods
+
+- [getAuthenticationToken](Request.md#getauthenticationtoken)
+- [getBody](Request.md#getbody)
+- [getForm](Request.md#getform)
+- [getForwardedIP](Request.md#getforwardedip)
+- [getHeader](Request.md#getheader)
+- [getHeaders](Request.md#getheaders)
+- [getHostname](Request.md#gethostname)
+- [getIP](Request.md#getip)
+- [getMethod](Request.md#getmethod)
+- [getParam](Request.md#getparam)
+- [getParams](Request.md#getparams)
+- [getQueryVariables](Request.md#getqueryvariables)
+- [getRequestSource](Request.md#getrequestsource)
+- [getURL](Request.md#geturl)
+- [isSecure](Request.md#issecure)
+- [pipe](Request.md#pipe)
+- [unpipe](Request.md#unpipe)
+
+## Constructors
+
+### constructor
+
+• **new Request**<`TBody`, `TAuthToken`\>(`request`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TBody` | `any` |
+| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> |
+
+#### Defined in
+
+[src/Request.ts:42](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L42)
+
+## Methods
+
+### getAuthenticationToken
+
+▸ **getAuthenticationToken**(): `Promise`<`TAuthToken`\>
+
+#### Returns
+
+`Promise`<`TAuthToken`\>
+
+#### Defined in
+
+[src/Request.ts:132](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L132)
+
+___
+
+### getBody
+
+▸ **getBody**(): `TBody`
+
+#### Returns
+
+`TBody`
+
+#### Defined in
+
+[src/Request.ts:46](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L46)
+
+___
+
+### getForm
+
+▸ **getForm**(): `Promise`<[`IFormData`](../interfaces/IFormData.md)\>
+
+#### Returns
+
+`Promise`<[`IFormData`](../interfaces/IFormData.md)\>
+
+#### Defined in
+
+[src/Request.ts:50](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L50)
+
+___
+
+### getForwardedIP
+
+▸ **getForwardedIP**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Request.ts:100](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L100)
+
+___
+
+### getHeader
+
+▸ **getHeader**(`name`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Request.ts:74](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L74)
+
+___
+
+### getHeaders
+
+▸ **getHeaders**(): `IncomingHttpHeaders`
+
+#### Returns
+
+`IncomingHttpHeaders`
+
+#### Defined in
+
+[src/Request.ts:70](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L70)
+
+___
+
+### getHostname
+
+▸ **getHostname**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Request.ts:104](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L104)
+
+___
+
+### getIP
+
+▸ **getIP**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Request.ts:96](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L96)
+
+___
+
+### getMethod
+
+▸ **getMethod**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Request.ts:108](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L108)
+
+___
+
+### getParam
+
+▸ **getParam**(`name`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Request.ts:92](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L92)
+
+___
+
+### getParams
+
+▸ **getParams**(): [`IParameterMap`](../interfaces/IParameterMap.md)
+
+#### Returns
+
+[`IParameterMap`](../interfaces/IParameterMap.md)
+
+#### Defined in
+
+[src/Request.ts:88](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L88)
+
+___
+
+### getQueryVariables
+
+▸ **getQueryVariables**(): `any`
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+[src/Request.ts:84](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L84)
+
+___
+
+### getRequestSource
+
+▸ **getRequestSource**(): `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>
+
+#### Returns
+
+`Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>
+
+#### Defined in
+
+[src/Request.ts:128](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L128)
+
+___
+
+### getURL
+
+▸ **getURL**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/Request.ts:112](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L112)
+
+___
+
+### isSecure
+
+▸ **isSecure**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/Request.ts:116](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L116)
+
+___
+
+### pipe
+
+▸ **pipe**(`destination`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `destination` | `Writable` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+[src/Request.ts:120](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L120)
+
+___
+
+### unpipe
+
+▸ **unpipe**(`source`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `source` | `Writable` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/Request.ts:124](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L124)