@breautek/storm 5.0.1 → 6.0.1

package/docs/classes/Transaction.md

@@ -1,161 +0,0 @@
-[@breautek/storm](../README.md) / Transaction
-
-# Class: Transaction
-
-A class encapsulating an entire transaction from beginning to commitment.
-
-This encapsulates a routine to conduct for the transaction.
-Should the transaction fail due to a deadlock, the transaction will automatically
-be tried.
-
-## Implements
-
-- [`IQueryable`](../interfaces/IQueryable.md)<`void`\>
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Transaction.md#constructor)
-
-### Methods
-
-- [execute](Transaction.md#execute)
-- [getParametersForQuery](Transaction.md#getparametersforquery)
-- [getQuery](Transaction.md#getquery)
-- [onPostProcess](Transaction.md#onpostprocess)
-- [onPreQuery](Transaction.md#onprequery)
-
-## Constructors
-
-### constructor
-
-• **new Transaction**(`app`, `executor`, `retryLimit?`, `isolationLevel?`)
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `app` | [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\> | `undefined` |
-| `executor` | `ITransactionExecutor` | `undefined` |
-| `retryLimit` | `number` | `Infinity` |
-| `isolationLevel` | [`IsolationLevel`](../enums/IsolationLevel.md) | `IsolationLevel.REPEATABLE_READ` |
-
-#### Defined in
-
-[src/Transaction.ts:43](https://github.com/breautek/storm/blob/3dcafe4/src/Transaction.ts#L43)
-
-## Methods
-
-### execute
-
-▸ **execute**(`connection`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[execute](../interfaces/IQueryable.md#execute)
-
-#### Defined in
-
-[src/Transaction.ts:70](https://github.com/breautek/storm/blob/3dcafe4/src/Transaction.ts#L70)
-
-___
-
-### getParametersForQuery
-
-▸ **getParametersForQuery**(): `Record`<`string`, `any`\>
-
-#### Returns
-
-`Record`<`string`, `any`\>
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[getParametersForQuery](../interfaces/IQueryable.md#getparametersforquery)
-
-#### Defined in
-
-[src/Transaction.ts:63](https://github.com/breautek/storm/blob/3dcafe4/src/Transaction.ts#L63)
-
-___
-
-### getQuery
-
-▸ **getQuery**(`connection`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`string`
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[getQuery](../interfaces/IQueryable.md#getquery)
-
-#### Defined in
-
-[src/Transaction.ts:60](https://github.com/breautek/storm/blob/3dcafe4/src/Transaction.ts#L60)
-
-___
-
-### onPostProcess
-
-▸ **onPostProcess**(`connection`, `results`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-| `results` | `any` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[onPostProcess](../interfaces/IQueryable.md#onpostprocess)
-
-#### Defined in
-
-[src/Transaction.ts:66](https://github.com/breautek/storm/blob/3dcafe4/src/Transaction.ts#L66)
-
-___
-
-### onPreQuery
-
-▸ **onPreQuery**(`connection`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[onPreQuery](../interfaces/IQueryable.md#onprequery)
-
-#### Defined in
-
-[src/Transaction.ts:58](https://github.com/breautek/storm/blob/3dcafe4/src/Transaction.ts#L58)

package/docs/classes/UnauthorizedAccessError.md

@@ -1,341 +0,0 @@
-[@breautek/storm](../README.md) / UnauthorizedAccessError
-
-# Class: UnauthorizedAccessError
-
-## Hierarchy
-
-- [`StormError`](StormError.md)
-
-  ↳ **`UnauthorizedAccessError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](UnauthorizedAccessError.md#constructor)
-
-### Properties
-
-- [message](UnauthorizedAccessError.md#message)
-- [name](UnauthorizedAccessError.md#name)
-- [stack](UnauthorizedAccessError.md#stack)
-- [prepareStackTrace](UnauthorizedAccessError.md#preparestacktrace)
-- [stackTraceLimit](UnauthorizedAccessError.md#stacktracelimit)
-
-### Methods
-
-- [getCode](UnauthorizedAccessError.md#getcode)
-- [getErrorResponse](UnauthorizedAccessError.md#geterrorresponse)
-- [getExitCode](UnauthorizedAccessError.md#getexitcode)
-- [getHTTPCode](UnauthorizedAccessError.md#gethttpcode)
-- [getLocaleCode](UnauthorizedAccessError.md#getlocalecode)
-- [getLocaleParameters](UnauthorizedAccessError.md#getlocaleparameters)
-- [getMessage](UnauthorizedAccessError.md#getmessage)
-- [getPrivateDetails](UnauthorizedAccessError.md#getprivatedetails)
-- [getPublicDetails](UnauthorizedAccessError.md#getpublicdetails)
-- [captureStackTrace](UnauthorizedAccessError.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new UnauthorizedAccessError**(`userToken`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userToken` | `string` |
-
-#### Overrides
-
-[StormError](StormError.md).[constructor](StormError.md#constructor)
-
-#### Defined in
-
-[src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/UnauthorizedAccessError.ts#L22)
-
-## 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/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/3dcafe4/src/UnauthorizedAccessError.ts#L30)
-
-___
-
-### 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/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/3dcafe4/src/UnauthorizedAccessError.ts#L34)
-
-___
-
-### getLocaleCode
-
-▸ **getLocaleCode**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
-
-#### Defined in
-
-[src/UnauthorizedAccessError.ts:38](https://github.com/breautek/storm/blob/3dcafe4/src/UnauthorizedAccessError.ts#L38)
-
-___
-
-### getLocaleParameters
-
-▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
-
-#### Returns
-
-`Record`<`string`, `string`\>
-
-#### Inherited from
-
-[StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
-
-#### Defined in
-
-[src/StormError.ts:93](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L93)
-
-___
-
-### getMessage
-
-▸ **getMessage**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[StormError](StormError.md).[getMessage](StormError.md#getmessage)
-
-#### Defined in
-
-[src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/3dcafe4/src/UnauthorizedAccessError.ts#L26)
-
-___
-
-### getPrivateDetails
-
-▸ **getPrivateDetails**(): `any`
-
-Private details are only logged to the server log.
-They are kept secret from the client.
-
-#### Returns
-
-`any`
-
-#### 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

package/docs/enums/ErrorCode.md

@@ -1,107 +0,0 @@
-[@breautek/storm](../README.md) / ErrorCode
-
-# Enumeration: ErrorCode
-
-## Table of contents
-
-### Enumeration Members
-
-- [DUPLICATE\_ENTRY](ErrorCode.md#duplicate_entry)
-- [EXPIRED\_TOKEN](ErrorCode.md#expired_token)
-- [INSUFFICIENT\_DISK\_SPACE](ErrorCode.md#insufficient_disk_space)
-- [INTERNAL](ErrorCode.md#internal)
-- [INVALID\_CONFIG](ErrorCode.md#invalid_config)
-- [INVALID\_CREDENTIALS](ErrorCode.md#invalid_credentials)
-- [INVALID\_VALUE](ErrorCode.md#invalid_value)
-- [MISSING\_PARAMETER](ErrorCode.md#missing_parameter)
-- [UNAUTHORIZED\_ACCESS](ErrorCode.md#unauthorized_access)
-
-## Enumeration Members
-
-### DUPLICATE\_ENTRY
-
-• **DUPLICATE\_ENTRY** = ``5``
-
-#### Defined in
-
-[src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L23)
-
-___
-
-### EXPIRED\_TOKEN
-
-• **EXPIRED\_TOKEN** = ``2``
-
-#### Defined in
-
-[src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L20)
-
-___
-
-### INSUFFICIENT\_DISK\_SPACE
-
-• **INSUFFICIENT\_DISK\_SPACE** = ``7``
-
-#### Defined in
-
-[src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L25)
-
-___
-
-### INTERNAL
-
-• **INTERNAL** = ``0``
-
-#### Defined in
-
-[src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L18)
-
-___
-
-### INVALID\_CONFIG
-
-• **INVALID\_CONFIG** = ``8``
-
-#### Defined in
-
-[src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L26)
-
-___
-
-### INVALID\_CREDENTIALS
-
-• **INVALID\_CREDENTIALS** = ``3``
-
-#### Defined in
-
-[src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L21)
-
-___
-
-### INVALID\_VALUE
-
-• **INVALID\_VALUE** = ``4``
-
-#### Defined in
-
-[src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L22)
-
-___
-
-### MISSING\_PARAMETER
-
-• **MISSING\_PARAMETER** = ``1``
-
-#### Defined in
-
-[src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L19)
-
-___
-
-### UNAUTHORIZED\_ACCESS
-
-• **UNAUTHORIZED\_ACCESS** = ``6``
-
-#### Defined in
-
-[src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/ErrorCode.ts#L24)

package/docs/enums/ExitCode.md

@@ -1,30 +0,0 @@
-[@breautek/storm](../README.md) / ExitCode
-
-# Enumeration: ExitCode
-
-## Table of contents
-
-### Enumeration Members
-
-- [INVALID\_CONFIG](ExitCode.md#invalid_config)
-- [MISSING\_CONFIG](ExitCode.md#missing_config)
-
-## Enumeration Members
-
-### INVALID\_CONFIG
-
-• **INVALID\_CONFIG** = ``2``
-
-#### Defined in
-
-[src/ExitCode.ts:19](https://github.com/breautek/storm/blob/3dcafe4/src/ExitCode.ts#L19)
-
-___
-
-### MISSING\_CONFIG
-
-• **MISSING\_CONFIG** = ``1``
-
-#### Defined in
-
-[src/ExitCode.ts:18](https://github.com/breautek/storm/blob/3dcafe4/src/ExitCode.ts#L18)

package/docs/enums/HTTPMethod.md

@@ -1,52 +0,0 @@
-[@breautek/storm](../README.md) / HTTPMethod
-
-# Enumeration: HTTPMethod
-
-## Table of contents
-
-### Enumeration Members
-
-- [DELETE](HTTPMethod.md#delete)
-- [GET](HTTPMethod.md#get)
-- [POST](HTTPMethod.md#post)
-- [PUT](HTTPMethod.md#put)
-
-## Enumeration Members
-
-### DELETE
-
-• **DELETE** = ``"DELETE"``
-
-#### Defined in
-
-[src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/HTTPMethod.ts#L21)
-
-___
-
-### GET
-
-• **GET** = ``"GET"``
-
-#### Defined in
-
-[src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/3dcafe4/src/HTTPMethod.ts#L18)
-
-___
-
-### POST
-
-• **POST** = ``"POST"``
-
-#### Defined in
-
-[src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/3dcafe4/src/HTTPMethod.ts#L19)
-
-___
-
-### PUT
-
-• **PUT** = ``"PUT"``
-
-#### Defined in
-
-[src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/HTTPMethod.ts#L20)