@breautek/storm 5.0.1 → 6.0.1

package/docs/classes/RawError.md

@@ -1,351 +0,0 @@
-[@breautek/storm](../README.md) / RawError
-
-# Class: RawError
-
-A concrete error that accepts any arbitrary message string and optionally a code.
-It's not recommended to use this class as it will be hard to differentiate errors by
-tag name.
-
-## Hierarchy
-
-- [`StormError`](StormError.md)<{ `code?`: `number` ; `message`: `string`  }\>
-
-  ↳ **`RawError`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](RawError.md#constructor)
-
-### Properties
-
-- [message](RawError.md#message)
-- [name](RawError.md#name)
-- [stack](RawError.md#stack)
-- [prepareStackTrace](RawError.md#preparestacktrace)
-- [stackTraceLimit](RawError.md#stacktracelimit)
-
-### Methods
-
-- [getCode](RawError.md#getcode)
-- [getErrorResponse](RawError.md#geterrorresponse)
-- [getExitCode](RawError.md#getexitcode)
-- [getHTTPCode](RawError.md#gethttpcode)
-- [getLocaleCode](RawError.md#getlocalecode)
-- [getLocaleParameters](RawError.md#getlocaleparameters)
-- [getMessage](RawError.md#getmessage)
-- [getPrivateDetails](RawError.md#getprivatedetails)
-- [getPublicDetails](RawError.md#getpublicdetails)
-- [captureStackTrace](RawError.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new RawError**(`message`, `code?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `message` | `string` |
-| `code?` | `number` |
-
-#### Overrides
-
-[StormError](StormError.md).[constructor](StormError.md#constructor)
-
-#### Defined in
-
-[src/RawError.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/RawError.ts#L25)
-
-## 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**(): `number`
-
-#### Returns
-
-`number`
-
-#### Overrides
-
-[StormError](StormError.md).[getCode](StormError.md#getcode)
-
-#### Defined in
-
-[src/RawError.ts:32](https://github.com/breautek/storm/blob/3dcafe4/src/RawError.ts#L32)
-
-___
-
-### 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)
-
-#### Inherited from
-
-[StormError](StormError.md).[getHTTPCode](StormError.md#gethttpcode)
-
-#### Defined in
-
-[src/StormError.ts:72](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L72)
-
-___
-
-### getLocaleCode
-
-▸ **getLocaleCode**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
-
-#### Defined in
-
-[src/StormError.ts:89](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L89)
-
-___
-
-### 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/RawError.ts:36](https://github.com/breautek/storm/blob/3dcafe4/src/RawError.ts#L36)
-
-___
-
-### getPrivateDetails
-
-▸ **getPrivateDetails**(): `Object`
-
-Private details are only logged to the server log.
-They are kept secret from the client.
-
-#### Returns
-
-`Object`
-
-| Name | Type |
-| :------ | :------ |
-| `code?` | `number` |
-| `message` | `string` |
-
-#### 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/classes/RawQuery.md

@@ -1,224 +0,0 @@
-[@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/3dcafe4/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/3dcafe4/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:71](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L71)
-
-___
-
-### getParameters
-
-▸ **getParameters**(): `TQueryParameters`
-
-#### Returns
-
-`TQueryParameters`
-
-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`<`string`, `any`\>
-
-Query implementations may override this API to augment the parameters.
-
-#### Returns
-
-`Record`<`string`, `any`\>
-
-parameters that will be used when this query is ran.
-
-#### Inherited from
-
-[Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
-
-#### Defined in
-
-[src/Query.ts:39](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L39)
-
-___
-
-### 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`<`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: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)