@breautek/storm 3.4.0 → 4.0.0

package/docs/classes/MySQLDatabase.MySQLDatabase-1.md

@@ -1,316 +0,0 @@
-[@breautek/storm](../README.md) / [MySQLDatabase](../modules/MySQLDatabase.md) / MySQLDatabase
-
-# Class: MySQLDatabase
-
-[MySQLDatabase](../modules/MySQLDatabase.md).MySQLDatabase
-
-## Hierarchy
-
-- [`Database`](Database.Database-1.md)<`MySQL.PoolConfig`, `MySQL.PoolConnection`\>
-
-  ↳ **`MySQLDatabase`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](MySQLDatabase.MySQLDatabase-1.md#constructor)
-
-### Methods
-
-- [\_addNode](MySQLDatabase.MySQLDatabase-1.md#_addnode)
-- [\_destroy](MySQLDatabase.MySQLDatabase-1.md#_destroy)
-- [\_getConnection](MySQLDatabase.MySQLDatabase-1.md#_getconnection)
-- [\_removeNode](MySQLDatabase.MySQLDatabase-1.md#_removenode)
-- [addMaster](MySQLDatabase.MySQLDatabase-1.md#addmaster)
-- [addSlave](MySQLDatabase.MySQLDatabase-1.md#addslave)
-- [destroy](MySQLDatabase.MySQLDatabase-1.md#destroy)
-- [escape](MySQLDatabase.MySQLDatabase-1.md#escape)
-- [getConnection](MySQLDatabase.MySQLDatabase-1.md#getconnection)
-- [removeMaster](MySQLDatabase.MySQLDatabase-1.md#removemaster)
-- [removeSlave](MySQLDatabase.MySQLDatabase-1.md#removeslave)
-- [escape](MySQLDatabase.MySQLDatabase-1.md#escape)
-
-## Constructors
-
-### constructor
-
-• **new MySQLDatabase**()
-
-#### Overrides
-
-[Database](Database.Database-1.md).[constructor](Database.Database-1.md#constructor)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/6ea3887/src/MySQLDatabase.ts#L27)
-
-## Methods
-
-### \_addNode
-
-▸ `Protected` **_addNode**(`nodeID`, `config`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodeID` | `string` |
-| `config` | `PoolConfig` |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_addNode](Database.Database-1.md#_addnode)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/6ea3887/src/MySQLDatabase.ts#L49)
-
-___
-
-### \_destroy
-
-▸ `Protected` **_destroy**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_destroy](Database.Database-1.md#_destroy)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/6ea3887/src/MySQLDatabase.ts#L59)
-
-___
-
-### \_getConnection
-
-▸ `Protected` **_getConnection**(`query`, `requireWriteAccess`): `Promise`<[`MySQLConnection`](MySQLConnection.MySQLConnection-1.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `requireWriteAccess` | `boolean` |
-
-#### Returns
-
-`Promise`<[`MySQLConnection`](MySQLConnection.MySQLConnection-1.md)\>
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_getConnection](Database.Database-1.md#_getconnection)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/6ea3887/src/MySQLDatabase.ts#L72)
-
-___
-
-### \_removeNode
-
-▸ `Protected` **_removeNode**(`nodeID`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodeID` | `string` |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_removeNode](Database.Database-1.md#_removenode)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/6ea3887/src/MySQLDatabase.ts#L54)
-
-___
-
-### addMaster
-
-▸ **addMaster**(`config`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `config` | `PoolConfig` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[addMaster](Database.Database-1.md#addmaster)
-
-#### Defined in
-
-[src/Database.ts:32](https://github.com/breautek/storm/blob/6ea3887/src/Database.ts#L32)
-
-___
-
-### addSlave
-
-▸ **addSlave**(`slaveID`, `config`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `slaveID` | `string` |
-| `config` | `PoolConfig` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[addSlave](Database.Database-1.md#addslave)
-
-#### Defined in
-
-[src/Database.ts:46](https://github.com/breautek/storm/blob/6ea3887/src/Database.ts#L46)
-
-___
-
-### destroy
-
-▸ **destroy**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[destroy](Database.Database-1.md#destroy)
-
-#### Defined in
-
-[src/Database.ts:78](https://github.com/breautek/storm/blob/6ea3887/src/Database.ts#L78)
-
-___
-
-### escape
-
-▸ **escape**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[Database](Database.Database-1.md).[escape](Database.Database-1.md#escape)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/6ea3887/src/MySQLDatabase.ts#L40)
-
-___
-
-### getConnection
-
-▸ **getConnection**(`requireWriteAccess?`, `nodeID?`): `Promise`<[`DatabaseConnection`](DatabaseConnection.DatabaseConnection-1.md)<`PoolConnection`\>\>
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `requireWriteAccess` | `boolean` | `false` |
-| `nodeID?` | `string` | `undefined` |
-
-#### Returns
-
-`Promise`<[`DatabaseConnection`](DatabaseConnection.DatabaseConnection-1.md)<`PoolConnection`\>\>
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[getConnection](Database.Database-1.md#getconnection)
-
-#### Defined in
-
-[src/Database.ts:65](https://github.com/breautek/storm/blob/6ea3887/src/Database.ts#L65)
-
-___
-
-### removeMaster
-
-▸ **removeMaster**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[removeMaster](Database.Database-1.md#removemaster)
-
-#### Defined in
-
-[src/Database.ts:41](https://github.com/breautek/storm/blob/6ea3887/src/Database.ts#L41)
-
-___
-
-### removeSlave
-
-▸ **removeSlave**(`slaveID`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `slaveID` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[removeSlave](Database.Database-1.md#removeslave)
-
-#### Defined in
-
-[src/Database.ts:55](https://github.com/breautek/storm/blob/6ea3887/src/Database.ts#L55)
-
-___
-
-### escape
-
-▸ `Static` **escape**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/6ea3887/src/MySQLDatabase.ts#L45)

package/docs/classes/Request.Request-1.md

@@ -1,323 +0,0 @@
-[@breautek/storm](../README.md) / [Request](../modules/Request.md) / Request
-
-# Class: Request<TBody, TAuthToken\>
-
-[Request](../modules/Request.md).Request
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TBody` | `any` |
-| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)[`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md) |
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Request.Request-1.md#constructor)
-
-### Methods
-
-- [getAuthenticationToken](Request.Request-1.md#getauthenticationtoken)
-- [getBody](Request.Request-1.md#getbody)
-- [getForm](Request.Request-1.md#getform)
-- [getForwardedIP](Request.Request-1.md#getforwardedip)
-- [getHeader](Request.Request-1.md#getheader)
-- [getHeaders](Request.Request-1.md#getheaders)
-- [getHostname](Request.Request-1.md#gethostname)
-- [getIP](Request.Request-1.md#getip)
-- [getMethod](Request.Request-1.md#getmethod)
-- [getParam](Request.Request-1.md#getparam)
-- [getParams](Request.Request-1.md#getparams)
-- [getQueryVariables](Request.Request-1.md#getqueryvariables)
-- [getRequestSource](Request.Request-1.md#getrequestsource)
-- [getURL](Request.Request-1.md#geturl)
-- [isSecure](Request.Request-1.md#issecure)
-- [pipe](Request.Request-1.md#pipe)
-- [unpipe](Request.Request-1.md#unpipe)
-
-## Constructors
-
-### constructor
-
-• **new Request**<`TBody`, `TAuthToken`\>(`request`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TBody` | `any` |
-| `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)[`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.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/6ea3887/src/Request.ts#L42)
-
-## Methods
-
-### getAuthenticationToken
-
-▸ **getAuthenticationToken**(): `Promise`<`TAuthToken`\>
-
-#### Returns
-
-`Promise`<`TAuthToken`\>
-
-#### Defined in
-
-[src/Request.ts:132](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L132)
-
-___
-
-### getBody
-
-▸ **getBody**(): `TBody`
-
-#### Returns
-
-`TBody`
-
-#### Defined in
-
-[src/Request.ts:46](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L46)
-
-___
-
-### getForm
-
-▸ **getForm**(): `Promise`<[`IFormData`](../interfaces/IFormData.IFormData-1.md)\>
-
-#### Returns
-
-`Promise`<[`IFormData`](../interfaces/IFormData.IFormData-1.md)\>
-
-#### Defined in
-
-[src/Request.ts:50](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L50)
-
-___
-
-### getForwardedIP
-
-▸ **getForwardedIP**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Request.ts:100](https://github.com/breautek/storm/blob/6ea3887/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/6ea3887/src/Request.ts#L74)
-
-___
-
-### getHeaders
-
-▸ **getHeaders**(): `IncomingHttpHeaders`
-
-#### Returns
-
-`IncomingHttpHeaders`
-
-#### Defined in
-
-[src/Request.ts:70](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L70)
-
-___
-
-### getHostname
-
-▸ **getHostname**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Request.ts:104](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L104)
-
-___
-
-### getIP
-
-▸ **getIP**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Request.ts:96](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L96)
-
-___
-
-### getMethod
-
-▸ **getMethod**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Request.ts:108](https://github.com/breautek/storm/blob/6ea3887/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/6ea3887/src/Request.ts#L92)
-
-___
-
-### getParams
-
-▸ **getParams**(): [`IParameterMap`](../interfaces/Request.IParameterMap.md)
-
-#### Returns
-
-[`IParameterMap`](../interfaces/Request.IParameterMap.md)
-
-#### Defined in
-
-[src/Request.ts:88](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L88)
-
-___
-
-### getQueryVariables
-
-▸ **getQueryVariables**(): `any`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[src/Request.ts:84](https://github.com/breautek/storm/blob/6ea3887/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/6ea3887/src/Request.ts#L128)
-
-___
-
-### getURL
-
-▸ **getURL**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Request.ts:112](https://github.com/breautek/storm/blob/6ea3887/src/Request.ts#L112)
-
-___
-
-### isSecure
-
-▸ **isSecure**(): `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[src/Request.ts:116](https://github.com/breautek/storm/blob/6ea3887/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/6ea3887/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/6ea3887/src/Request.ts#L124)