@breautek/storm 5.0.1 → 6.0.1

package/docs/classes/MySQLDatabase.md

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

package/docs/classes/NotImplementedError.md

@@ -1,341 +0,0 @@
-[@breautek/storm](../README.md) / NotImplementedError
-
-# Class: NotImplementedError
-
-## Hierarchy
-
-- [`StormError`](StormError.md)<`INotImplementedErrorOptions`\>
-
-  ↳ **`NotImplementedError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](NotImplementedError.md#constructor)
-
-### Properties
-
-- [message](NotImplementedError.md#message)
-- [name](NotImplementedError.md#name)
-- [stack](NotImplementedError.md#stack)
-- [prepareStackTrace](NotImplementedError.md#preparestacktrace)
-- [stackTraceLimit](NotImplementedError.md#stacktracelimit)
-
-### Methods
-
-- [getCode](NotImplementedError.md#getcode)
-- [getErrorResponse](NotImplementedError.md#geterrorresponse)
-- [getExitCode](NotImplementedError.md#getexitcode)
-- [getHTTPCode](NotImplementedError.md#gethttpcode)
-- [getLocaleCode](NotImplementedError.md#getlocalecode)
-- [getLocaleParameters](NotImplementedError.md#getlocaleparameters)
-- [getMessage](NotImplementedError.md#getmessage)
-- [getPrivateDetails](NotImplementedError.md#getprivatedetails)
-- [getPublicDetails](NotImplementedError.md#getpublicdetails)
-- [captureStackTrace](NotImplementedError.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new NotImplementedError**(`method`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `method` | [`HTTPMethod`](../enums/HTTPMethod.md) |
-
-#### Overrides
-
-[StormError](StormError.md).[constructor](StormError.md#constructor)
-
-#### Defined in
-
-[src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/NotImplementedError.ts#L27)
-
-## Properties
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-[StormError](StormError.md).[message](StormError.md#message)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1054
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-[StormError](StormError.md).[name](StormError.md#name)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1053
-
-___
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-[StormError](StormError.md).[stack](StormError.md#stack)
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1055
-
-___
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-Optional override for formatting stack traces
-
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-#### Inherited from
-
-[StormError](StormError.md).[prepareStackTrace](StormError.md#preparestacktrace)
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:11
-
-___
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-[StormError](StormError.md).[stackTraceLimit](StormError.md#stacktracelimit)
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:13
-
-## Methods
-
-### getCode
-
-▸ **getCode**(): [`ErrorCode`](../enums/ErrorCode.md)
-
-#### Returns
-
-[`ErrorCode`](../enums/ErrorCode.md)
-
-#### Overrides
-
-[StormError](StormError.md).[getCode](StormError.md#getcode)
-
-#### Defined in
-
-[src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/3dcafe4/src/NotImplementedError.ts#L38)
-
-___
-
-### getErrorResponse
-
-▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
-
-#### Returns
-
-[`IErrorResponse`](../interfaces/IErrorResponse.md)
-
-#### Inherited from
-
-[StormError](StormError.md).[getErrorResponse](StormError.md#geterrorresponse)
-
-#### Defined in
-
-[src/StormError.ts:76](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L76)
-
-___
-
-### getExitCode
-
-▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
-
-#### Returns
-
-[`ExitCode`](../enums/ExitCode.md)
-
-#### Inherited from
-
-[StormError](StormError.md).[getExitCode](StormError.md#getexitcode)
-
-#### Defined in
-
-[src/StormError.ts:97](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L97)
-
-___
-
-### getHTTPCode
-
-▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
-
-#### Returns
-
-[`StatusCode`](../enums/StatusCode.md)
-
-#### Overrides
-
-[StormError](StormError.md).[getHTTPCode](StormError.md#gethttpcode)
-
-#### Defined in
-
-[src/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/3dcafe4/src/NotImplementedError.ts#L42)
-
-___
-
-### getLocaleCode
-
-▸ **getLocaleCode**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
-
-#### Defined in
-
-[src/NotImplementedError.ts:46](https://github.com/breautek/storm/blob/3dcafe4/src/NotImplementedError.ts#L46)
-
-___
-
-### getLocaleParameters
-
-▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
-
-#### Returns
-
-`Record`<`string`, `string`\>
-
-#### Overrides
-
-[StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
-
-#### Defined in
-
-[src/NotImplementedError.ts:50](https://github.com/breautek/storm/blob/3dcafe4/src/NotImplementedError.ts#L50)
-
-___
-
-### getMessage
-
-▸ **getMessage**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[StormError](StormError.md).[getMessage](StormError.md#getmessage)
-
-#### Defined in
-
-[src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/3dcafe4/src/NotImplementedError.ts#L33)
-
-___
-
-### getPrivateDetails
-
-▸ **getPrivateDetails**(): `INotImplementedErrorOptions`
-
-Private details are only logged to the server log.
-They are kept secret from the client.
-
-#### Returns
-
-`INotImplementedErrorOptions`
-
-#### Inherited from
-
-[StormError](StormError.md).[getPrivateDetails](StormError.md#getprivatedetails)
-
-#### Defined in
-
-[src/StormError.ts:68](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L68)
-
-___
-
-### getPublicDetails
-
-▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
-
-Sends details to the client.
-
-#### Returns
-
-[`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
-
-#### Inherited from
-
-[StormError](StormError.md).[getPublicDetails](StormError.md#getpublicdetails)
-
-#### Defined in
-
-[src/StormError.ts:60](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L60)
-
-___
-
-### captureStackTrace
-
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[StormError](StormError.md).[captureStackTrace](StormError.md#capturestacktrace)
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:4