@breautek/storm 3.4.0 → 4.0.0

package/docs/classes/EntityNotFoundError.md

@@ -0,0 +1,301 @@
+[@breautek/storm](../README.md) / EntityNotFoundError
+
+# Class: EntityNotFoundError
+
+## Hierarchy
+
+- [`StormError`](StormError.md)
+
+  ↳ **`EntityNotFoundError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](EntityNotFoundError.md#constructor)
+
+### Properties
+
+- [message](EntityNotFoundError.md#message)
+- [name](EntityNotFoundError.md#name)
+- [stack](EntityNotFoundError.md#stack)
+- [prepareStackTrace](EntityNotFoundError.md#preparestacktrace)
+- [stackTraceLimit](EntityNotFoundError.md#stacktracelimit)
+
+### Methods
+
+- [getCode](EntityNotFoundError.md#getcode)
+- [getErrorResponse](EntityNotFoundError.md#geterrorresponse)
+- [getExitCode](EntityNotFoundError.md#getexitcode)
+- [getHTTPCode](EntityNotFoundError.md#gethttpcode)
+- [getMessage](EntityNotFoundError.md#getmessage)
+- [getPrivateDetails](EntityNotFoundError.md#getprivatedetails)
+- [getPublicDetails](EntityNotFoundError.md#getpublicdetails)
+- [captureStackTrace](EntityNotFoundError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new EntityNotFoundError**(`name`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Overrides
+
+[StormError](StormError.md).[constructor](StormError.md#constructor)
+
+#### Defined in
+
+[src/EntityNotFoundError.ts:22](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.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:1023
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[name](StormError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[stack](StormError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### 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/EntityNotFoundError.ts:30](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.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:70](https://github.com/breautek/storm/blob/186ee78/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/186ee78/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/EntityNotFoundError.ts:34](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.ts#L34)
+
+___
+
+### getMessage
+
+▸ **getMessage**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[StormError](StormError.md).[getMessage](StormError.md#getmessage)
+
+#### Defined in
+
+[src/EntityNotFoundError.ts:26](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.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:62](https://github.com/breautek/storm/blob/186ee78/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/186ee78/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/ExpiredTokenError.md

@@ -0,0 +1,301 @@
+[@breautek/storm](../README.md) / ExpiredTokenError
+
+# Class: ExpiredTokenError
+
+## Hierarchy
+
+- [`StormError`](StormError.md)<`any`\>
+
+  ↳ **`ExpiredTokenError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ExpiredTokenError.md#constructor)
+
+### Properties
+
+- [message](ExpiredTokenError.md#message)
+- [name](ExpiredTokenError.md#name)
+- [stack](ExpiredTokenError.md#stack)
+- [prepareStackTrace](ExpiredTokenError.md#preparestacktrace)
+- [stackTraceLimit](ExpiredTokenError.md#stacktracelimit)
+
+### Methods
+
+- [getCode](ExpiredTokenError.md#getcode)
+- [getErrorResponse](ExpiredTokenError.md#geterrorresponse)
+- [getExitCode](ExpiredTokenError.md#getexitcode)
+- [getHTTPCode](ExpiredTokenError.md#gethttpcode)
+- [getMessage](ExpiredTokenError.md#getmessage)
+- [getPrivateDetails](ExpiredTokenError.md#getprivatedetails)
+- [getPublicDetails](ExpiredTokenError.md#getpublicdetails)
+- [captureStackTrace](ExpiredTokenError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new ExpiredTokenError**(`details?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `details?` | `any` |
+
+#### Overrides
+
+[StormError](StormError.md).[constructor](StormError.md#constructor)
+
+#### Defined in
+
+[src/ExpiredTokenError.ts:23](https://github.com/breautek/storm/blob/186ee78/src/ExpiredTokenError.ts#L23)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[message](StormError.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[name](StormError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[StormError](StormError.md).[stack](StormError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### 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/ExpiredTokenError.ts:31](https://github.com/breautek/storm/blob/186ee78/src/ExpiredTokenError.ts#L31)
+
+___
+
+### 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/186ee78/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/186ee78/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/ExpiredTokenError.ts:35](https://github.com/breautek/storm/blob/186ee78/src/ExpiredTokenError.ts#L35)
+
+___
+
+### getMessage
+
+▸ **getMessage**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[StormError](StormError.md).[getMessage](StormError.md#getmessage)
+
+#### Defined in
+
+[src/ExpiredTokenError.ts:27](https://github.com/breautek/storm/blob/186ee78/src/ExpiredTokenError.ts#L27)
+
+___
+
+### 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:62](https://github.com/breautek/storm/blob/186ee78/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/186ee78/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