@breautek/storm 5.0.1 → 6.0.1

package/docs/classes/ServiceProvider.md

@@ -1,296 +0,0 @@
-[@breautek/storm](../README.md) / ServiceProvider
-
-# Class: ServiceProvider
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ServiceProvider.md#constructor)
-
-### Methods
-
-- [\_createURL](ServiceProvider.md#_createurl)
-- [\_getApp](ServiceProvider.md#_getapp)
-- [\_getBase](ServiceProvider.md#_getbase)
-- [\_getDomain](ServiceProvider.md#_getdomain)
-- [\_getPort](ServiceProvider.md#_getport)
-- [\_getProtocol](ServiceProvider.md#_getprotocol)
-- [delete](ServiceProvider.md#delete)
-- [get](ServiceProvider.md#get)
-- [getApp](ServiceProvider.md#getapp)
-- [getVersion](ServiceProvider.md#getversion)
-- [post](ServiceProvider.md#post)
-- [put](ServiceProvider.md#put)
-- [request](ServiceProvider.md#request)
-- [urlSuffix](ServiceProvider.md#urlsuffix)
-
-## Constructors
-
-### constructor
-
-• **new ServiceProvider**(`app`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `app` | [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\> |
-
-#### Defined in
-
-[src/ServiceProvider.ts:29](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L29)
-
-## Methods
-
-### \_createURL
-
-▸ `Protected` **_createURL**(`url`, `queryParams?`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `queryParams?` | `Record`<`any`, `any`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:64](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L64)
-
-___
-
-### \_getApp
-
-▸ `Protected` **_getApp**(): [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
-
-#### Returns
-
-[`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:36](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L36)
-
-___
-
-### \_getBase
-
-▸ `Protected` `Abstract` **_getBase**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:33](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L33)
-
-___
-
-### \_getDomain
-
-▸ `Protected` **_getDomain**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:44](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L44)
-
-___
-
-### \_getPort
-
-▸ `Protected` `Abstract` **_getPort**(): `number`
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/ServiceProvider.ts:34](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L34)
-
-___
-
-### \_getProtocol
-
-▸ `Protected` **_getProtocol**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:56](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L56)
-
-___
-
-### delete
-
-▸ **delete**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:157](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L157)
-
-___
-
-### get
-
-▸ **get**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:142](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L142)
-
-___
-
-### getApp
-
-▸ **getApp**(): [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
-
-#### Returns
-
-[`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:40](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L40)
-
-___
-
-### getVersion
-
-▸ **getVersion**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:60](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L60)
-
-___
-
-### post
-
-▸ **post**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:147](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L147)
-
-___
-
-### put
-
-▸ **put**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:152](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L152)
-
-___
-
-### request
-
-▸ **request**(`method`, `url`, `accessToken`, `data`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `method` | [`HTTPMethod`](../enums/HTTPMethod.md) |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:82](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L82)
-
-___
-
-### urlSuffix
-
-▸ **urlSuffix**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:52](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceProvider.ts#L52)

package/docs/classes/ServiceResponse.md

@@ -1,89 +0,0 @@
-[@breautek/storm](../README.md) / ServiceResponse
-
-# Class: ServiceResponse
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ServiceResponse.md#constructor)
-
-### Methods
-
-- [getJSON](ServiceResponse.md#getjson)
-- [getRaw](ServiceResponse.md#getraw)
-- [getStatusCode](ServiceResponse.md#getstatuscode)
-- [getUTF8](ServiceResponse.md#getutf8)
-
-## Constructors
-
-### constructor
-
-• **new ServiceResponse**(`data`, `response`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `data` | `Buffer` |
-| `response` | `IncomingMessage` |
-
-#### Defined in
-
-[src/ServiceResponse.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceResponse.ts#L24)
-
-## Methods
-
-### getJSON
-
-▸ **getJSON**(): `any`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[src/ServiceResponse.ts:37](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceResponse.ts#L37)
-
-___
-
-### getRaw
-
-▸ **getRaw**(): `Buffer`
-
-#### Returns
-
-`Buffer`
-
-#### Defined in
-
-[src/ServiceResponse.ts:29](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceResponse.ts#L29)
-
-___
-
-### getStatusCode
-
-▸ **getStatusCode**(): [`StatusCode`](../enums/StatusCode.md)
-
-#### Returns
-
-[`StatusCode`](../enums/StatusCode.md)
-
-#### Defined in
-
-[src/ServiceResponse.ts:41](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceResponse.ts#L41)
-
-___
-
-### getUTF8
-
-▸ **getUTF8**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceResponse.ts:33](https://github.com/breautek/storm/blob/3dcafe4/src/ServiceResponse.ts#L33)

package/docs/classes/SetSessionVariableQuery.md

@@ -1,207 +0,0 @@
-[@breautek/storm](../README.md) / SetSessionVariableQuery
-
-# Class: SetSessionVariableQuery
-
-## Hierarchy
-
-- [`Query`](Query.md)<[`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md), `void`\>
-
-  ↳ **`SetSessionVariableQuery`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](SetSessionVariableQuery.md#constructor)
-
-### Methods
-
-- [\_getQuery](SetSessionVariableQuery.md#_getquery)
-- [execute](SetSessionVariableQuery.md#execute)
-- [getParameters](SetSessionVariableQuery.md#getparameters)
-- [getParametersForQuery](SetSessionVariableQuery.md#getparametersforquery)
-- [getQuery](SetSessionVariableQuery.md#getquery)
-- [onPostProcess](SetSessionVariableQuery.md#onpostprocess)
-- [onPreQuery](SetSessionVariableQuery.md#onprequery)
-
-## Constructors
-
-### constructor
-
-• **new SetSessionVariableQuery**(`parameters?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `parameters?` | [`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md) |
-
-#### Inherited from
-
-[Query](Query.md).[constructor](Query.md#constructor)
-
-#### Defined in
-
-[src/Query.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L23)
-
-## Methods
-
-### \_getQuery
-
-▸ `Protected` **_getQuery**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[Query](Query.md).[_getQuery](Query.md#_getquery)
-
-#### Defined in
-
-[src/SetSessionVariableQuery.ts:12](https://github.com/breautek/storm/blob/3dcafe4/src/SetSessionVariableQuery.ts#L12)
-
-___
-
-### execute
-
-▸ **execute**(`connection`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Inherited from
-
-[Query](Query.md).[execute](Query.md#execute)
-
-#### Defined in
-
-[src/Query.ts:71](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L71)
-
-___
-
-### getParameters
-
-▸ **getParameters**(): [`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md)
-
-#### Returns
-
-[`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md)
-
-parameters that was passed into the constructor.
-
-#### Inherited from
-
-[Query](Query.md).[getParameters](Query.md#getparameters)
-
-#### Defined in
-
-[src/Query.ts:30](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L30)
-
-___
-
-### getParametersForQuery
-
-▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
-
-Query implementations may override this API to augment the parameters.
-
-#### Returns
-
-`Record`<`any`, `any`\>
-
-parameters that will be used when this query is ran.
-
-#### Overrides
-
-[Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
-
-#### Defined in
-
-[src/SetSessionVariableQuery.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/SetSessionVariableQuery.ts#L23)
-
-___
-
-### 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:45](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L45)
-
-___
-
-### onPostProcess
-
-▸ **onPostProcess**(`connection`, `resultSet`): `Promise`<`void`\>
-
-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` | `void` | - |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Inherited from
-
-[Query](Query.md).[onPostProcess](Query.md#onpostprocess)
-
-#### Defined in
-
-[src/Query.ts:66](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L66)
-
-___
-
-### 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:56](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L56)