@breautek/storm 4.1.0 → 4.3.0

package/docs/classes/RawError.md

@@ -0,0 +1,351 @@
+[@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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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

@@ -59,7 +59,7 @@
 
 #### Defined in
 
-[src/RawQuery.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/RawQuery.ts#L22)
+[src/RawQuery.ts:22](https://github.com/breautek/storm/blob/4ac2f44/src/RawQuery.ts#L22)
 
 ## Methods
 
@@ -77,7 +77,7 @@
 
 #### Defined in
 
-[src/RawQuery.ts:27](https://github.com/breautek/storm/blob/3ad3438/src/RawQuery.ts#L27)
+[src/RawQuery.ts:27](https://github.com/breautek/storm/blob/4ac2f44/src/RawQuery.ts#L27)
 
 ___
 
@@ -101,7 +101,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L62)
+[src/Query.ts:70](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L70)
 
 ___
 
@@ -113,13 +113,15 @@ ___
 
 `TQueryParameters`
 
+parameters that was passed into the constructor.
+
 #### Inherited from
 
 [Query](Query.md).[getParameters](Query.md#getparameters)
 
 #### Defined in
 
-[src/Query.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L26)
+[src/Query.ts:29](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L29)
 
 ___
 
@@ -127,17 +129,21 @@ ___
 
 ▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
 
+Query implementations may override this API to augment the parameters.
+
 #### Returns
 
 `Record`<`any`, `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:30](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L30)
+[src/Query.ts:38](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L38)
 
 ___
 
@@ -161,7 +167,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L36)
+[src/Query.ts:44](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L44)
 
 ___
 
@@ -188,7 +194,7 @@ Override to augment/manipulate the returned result set.
 
 #### Defined in
 
-[src/Query.ts:57](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L57)
+[src/Query.ts:65](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L65)
 
 ___
 
@@ -215,4 +221,4 @@ Can be used to set session variables or create temporary tables, etc.
 
 #### Defined in
 
-[src/Query.ts:47](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L47)
+[src/Query.ts:55](https://github.com/breautek/storm/blob/4ac2f44/src/Query.ts#L55)

package/docs/classes/Request.md

@@ -56,7 +56,7 @@
 
 #### Defined in
 
-[src/Request.ts:42](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L42)
+[src/Request.ts:42](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L42)
 
 ## Methods
 
@@ -70,7 +70,7 @@
 
 #### Defined in
 
-[src/Request.ts:132](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L132)
+[src/Request.ts:132](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L132)
 
 ___
 
@@ -84,7 +84,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:46](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L46)
+[src/Request.ts:46](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L46)
 
 ___
 
@@ -98,7 +98,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:50](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L50)
+[src/Request.ts:50](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L50)
 
 ___
 
@@ -112,7 +112,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:100](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L100)
+[src/Request.ts:100](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L100)
 
 ___
 
@@ -132,7 +132,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:74](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L74)
+[src/Request.ts:74](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L74)
 
 ___
 
@@ -146,7 +146,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:70](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L70)
+[src/Request.ts:70](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L70)
 
 ___
 
@@ -160,7 +160,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:104](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L104)
+[src/Request.ts:104](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L104)
 
 ___
 
@@ -174,7 +174,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:96](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L96)
+[src/Request.ts:96](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L96)
 
 ___
 
@@ -188,7 +188,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:108](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L108)
+[src/Request.ts:108](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L108)
 
 ___
 
@@ -208,7 +208,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:92](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L92)
+[src/Request.ts:92](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L92)
 
 ___
 
@@ -222,7 +222,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:88](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L88)
+[src/Request.ts:88](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L88)
 
 ___
 
@@ -236,7 +236,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:84](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L84)
+[src/Request.ts:84](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L84)
 
 ___
 
@@ -250,7 +250,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:128](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L128)
+[src/Request.ts:128](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L128)
 
 ___
 
@@ -264,7 +264,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:112](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L112)
+[src/Request.ts:112](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L112)
 
 ___
 
@@ -278,7 +278,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:116](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L116)
+[src/Request.ts:116](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L116)
 
 ___
 
@@ -298,7 +298,7 @@ ___
 
 #### Defined in
 
-[src/Request.ts:120](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L120)
+[src/Request.ts:120](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L120)
 
 ___
 
@@ -318,4 +318,4 @@ ___
 
 #### Defined in
 
-[src/Request.ts:124](https://github.com/breautek/storm/blob/3ad3438/src/Request.ts#L124)
+[src/Request.ts:124](https://github.com/breautek/storm/blob/4ac2f44/src/Request.ts#L124)

package/docs/classes/Response.md

@@ -50,7 +50,7 @@
 
 #### Defined in
 
-[src/Response.ts:38](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L38)
+[src/Response.ts:38](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L38)
 
 ## Methods
 
@@ -70,7 +70,7 @@
 
 #### Defined in
 
-[src/Response.ts:130](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L130)
+[src/Response.ts:130](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L130)
 
 ___
 
@@ -84,7 +84,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:49](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L49)
+[src/Response.ts:49](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L49)
 
 ___
 
@@ -98,7 +98,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:126](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L126)
+[src/Response.ts:126](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L126)
 
 ___
 
@@ -118,7 +118,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:99](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L99)
+[src/Response.ts:99](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L99)
 
 ___
 
@@ -138,7 +138,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:53](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L53)
+[src/Response.ts:53](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L53)
 
 ___
 
@@ -158,7 +158,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:94](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L94)
+[src/Response.ts:94](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L94)
 
 ___
 
@@ -179,7 +179,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:118](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L118)
+[src/Response.ts:118](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L118)
 
 ___
 
@@ -199,7 +199,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:122](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L122)
+[src/Response.ts:122](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L122)
 
 ___
 
@@ -219,7 +219,7 @@ ___
 
 #### Defined in
 
-[src/Response.ts:44](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L44)
+[src/Response.ts:44](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L44)
 
 ___
 
@@ -239,4 +239,4 @@ ___
 
 #### Defined in
 
-[src/Response.ts:107](https://github.com/breautek/storm/blob/3ad3438/src/Response.ts#L107)
+[src/Response.ts:107](https://github.com/breautek/storm/blob/4ac2f44/src/Response.ts#L107)