@breautek/storm 4.0.0 → 4.2.0

package/docs/classes/NotImplementedError.md

@@ -0,0 +1,301 @@
+[@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)
+- [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/f198938/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:1029
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[name](StormError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1028
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[stack](StormError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1030
+
+___
+
+### 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/f198938/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:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
+
+___
+
+### 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:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
+
+___
+
+### 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/f198938/src/NotImplementedError.ts#L42)
+
+___
+
+### 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/f198938/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:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
+
+___
+
+### 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:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
+
+___
+
+### 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/Query.md

@@ -60,7 +60,7 @@
 
 #### Defined in
 
-[src/Query.ts:23](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L23)
+[src/Query.ts:22](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L22)
 
 ## Methods
 
@@ -80,7 +80,7 @@
 
 #### Defined in
 
-[src/Query.ts:35](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L35)
+[src/Query.ts:42](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L42)
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:63](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L63)
+[src/Query.ts:70](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L70)
 
 ___
 
@@ -112,23 +112,29 @@ ___
 
 `TQueryParameters`
 
+parameters that was passed into the constructor.
+
 #### Defined in
 
-[src/Query.ts:27](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L27)
+[src/Query.ts:29](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L29)
 
 ___
 
 ### getParametersForQuery
 
-▸ **getParametersForQuery**(): `IDictionary`<`any`\>
+▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
+
+Query implementations may override this API to augment the parameters.
 
 #### Returns
 
-`IDictionary`<`any`\>
+`Record`<`any`, `any`\>
+
+parameters that will be used when this query is ran.
 
 #### Defined in
 
-[src/Query.ts:31](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L31)
+[src/Query.ts:38](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L38)
 
 ___
 
@@ -148,7 +154,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:37](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L37)
+[src/Query.ts:44](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L44)
 
 ___
 
@@ -171,7 +177,7 @@ Override to augment/manipulate the returned result set.
 
 #### Defined in
 
-[src/Query.ts:58](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L58)
+[src/Query.ts:65](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L65)
 
 ___
 
@@ -194,4 +200,4 @@ Can be used to set session variables or create temporary tables, etc.
 
 #### Defined in
 
-[src/Query.ts:48](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L48)
+[src/Query.ts:55](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L55)

package/docs/classes/RawError.md

@@ -0,0 +1,313 @@
+[@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)
+- [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/f198938/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:1029
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[name](StormError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1028
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[stack](StormError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1030
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+Optional override for formatting stack traces
+
+#### 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/f198938/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:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
+
+___
+
+### 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:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
+
+___
+
+### 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:66](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L66)
+
+___
+
+### 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/f198938/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:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
+
+___
+
+### 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:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
+
+___
+
+### 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