@breautek/storm 4.2.0 → 4.4.0

package/docs/classes/DeadLockError.md

@@ -0,0 +1,349 @@
+[@breautek/storm](../README.md) / DeadLockError
+
+# Class: DeadLockError
+
+DeadLockError is a DatabaseQueryError but is subclasses for typing purposes.
+
+## Hierarchy
+
+- [`DatabaseQueryError`](DatabaseQueryError.md)
+
+  ↳ **`DeadLockError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DeadLockError.md#constructor)
+
+### Properties
+
+- [message](DeadLockError.md#message)
+- [name](DeadLockError.md#name)
+- [stack](DeadLockError.md#stack)
+- [prepareStackTrace](DeadLockError.md#preparestacktrace)
+- [stackTraceLimit](DeadLockError.md#stacktracelimit)
+
+### Methods
+
+- [getCode](DeadLockError.md#getcode)
+- [getErrorResponse](DeadLockError.md#geterrorresponse)
+- [getExitCode](DeadLockError.md#getexitcode)
+- [getHTTPCode](DeadLockError.md#gethttpcode)
+- [getLocaleCode](DeadLockError.md#getlocalecode)
+- [getLocaleParameters](DeadLockError.md#getlocaleparameters)
+- [getMessage](DeadLockError.md#getmessage)
+- [getPrivateDetails](DeadLockError.md#getprivatedetails)
+- [getPublicDetails](DeadLockError.md#getpublicdetails)
+- [captureStackTrace](DeadLockError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new DeadLockError**(`query`, `error`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `query` | `string` |
+| `error` | `any` |
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[constructor](DatabaseQueryError.md#constructor)
+
+#### Defined in
+
+[src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L25)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[message](DatabaseQueryError.md#message)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1041
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[name](DatabaseQueryError.md#name)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1040
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[stack](DatabaseQueryError.md#stack)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1042
+
+___
+
+### 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
+
+[DatabaseQueryError](DatabaseQueryError.md).[prepareStackTrace](DatabaseQueryError.md#preparestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/ts4.8/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[stackTraceLimit](DatabaseQueryError.md#stacktracelimit)
+
+#### Defined in
+
+node_modules/@types/node/ts4.8/globals.d.ts:13
+
+## Methods
+
+### getCode
+
+▸ **getCode**(): `number`
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getCode](DatabaseQueryError.md#getcode)
+
+#### Defined in
+
+[src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L36)
+
+___
+
+### getErrorResponse
+
+▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
+
+#### Returns
+
+[`IErrorResponse`](../interfaces/IErrorResponse.md)
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getErrorResponse](DatabaseQueryError.md#geterrorresponse)
+
+#### Defined in
+
+[src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
+
+___
+
+### getExitCode
+
+▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
+
+#### Returns
+
+[`ExitCode`](../enums/ExitCode.md)
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getExitCode](DatabaseQueryError.md#getexitcode)
+
+#### Defined in
+
+[src/StormError.ts:97](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L97)
+
+___
+
+### getHTTPCode
+
+▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
+
+#### Returns
+
+[`StatusCode`](../enums/StatusCode.md)
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getHTTPCode](DatabaseQueryError.md#gethttpcode)
+
+#### Defined in
+
+[src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L40)
+
+___
+
+### getLocaleCode
+
+▸ **getLocaleCode**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getLocaleCode](DatabaseQueryError.md#getlocalecode)
+
+#### Defined in
+
+[src/DatabaseQueryError.ts:44](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L44)
+
+___
+
+### getLocaleParameters
+
+▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
+
+#### Returns
+
+`Record`<`string`, `string`\>
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getLocaleParameters](DatabaseQueryError.md#getlocaleparameters)
+
+#### Defined in
+
+[src/StormError.ts:93](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L93)
+
+___
+
+### getMessage
+
+▸ **getMessage**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getMessage](DatabaseQueryError.md#getmessage)
+
+#### Defined in
+
+[src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L32)
+
+___
+
+### getPrivateDetails
+
+▸ **getPrivateDetails**(): `Object`
+
+Private details are only logged to the server log.
+They are kept secret from the client.
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `any` |
+| `query` | `string` |
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getPrivateDetails](DatabaseQueryError.md#getprivatedetails)
+
+#### Defined in
+
+[src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
+
+___
+
+### getPublicDetails
+
+▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
+
+Sends details to the client.
+
+#### Returns
+
+[`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
+
+#### Inherited from
+
+[DatabaseQueryError](DatabaseQueryError.md).[getPublicDetails](DatabaseQueryError.md#getpublicdetails)
+
+#### Defined in
+
+[src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/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
+
+[DatabaseQueryError](DatabaseQueryError.md).[captureStackTrace](DatabaseQueryError.md#capturestacktrace)
+
+#### Defined in
+
+node_modules/@types/node/ts4.8/globals.d.ts:4

package/docs/classes/DiskSpaceError.md

@@ -28,6 +28,8 @@
 - [getErrorResponse](DiskSpaceError.md#geterrorresponse)
 - [getExitCode](DiskSpaceError.md#getexitcode)
 - [getHTTPCode](DiskSpaceError.md#gethttpcode)
+- [getLocaleCode](DiskSpaceError.md#getlocalecode)
+- [getLocaleParameters](DiskSpaceError.md#getlocaleparameters)
 - [getMessage](DiskSpaceError.md#getmessage)
 - [getPrivateDetails](DiskSpaceError.md#getprivatedetails)
 - [getPublicDetails](DiskSpaceError.md#getpublicdetails)
@@ -51,7 +53,7 @@
 
 #### Defined in
 
-[src/DiskSpaceError.ts:22](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L22)
+[src/DiskSpaceError.ts:22](https://github.com/breautek/storm/blob/0875c73/src/DiskSpaceError.ts#L22)
 
 ## Properties
 
@@ -65,7 +67,7 @@
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1029
+node_modules/typescript/lib/lib.es5.d.ts:1041
 
 ___
 
@@ -79,7 +81,7 @@ ___
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1028
+node_modules/typescript/lib/lib.es5.d.ts:1040
 
 ___
 
@@ -93,7 +95,7 @@ ___
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1030
+node_modules/typescript/lib/lib.es5.d.ts:1042
 
 ___
 
@@ -107,7 +109,9 @@ ___
 
 Optional override for formatting stack traces
 
-**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 ##### Parameters
 
@@ -126,7 +130,7 @@ Optional override for formatting stack traces
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:11
+node_modules/@types/node/ts4.8/globals.d.ts:11
 
 ___
 
@@ -140,7 +144,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:13
+node_modules/@types/node/ts4.8/globals.d.ts:13
 
 ## Methods
 
@@ -158,7 +162,7 @@ node_modules/@types/node/globals.d.ts:13
 
 #### Defined in
 
-[src/DiskSpaceError.ts:32](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L32)
+[src/DiskSpaceError.ts:32](https://github.com/breautek/storm/blob/0875c73/src/DiskSpaceError.ts#L32)
 
 ___
 
@@ -176,7 +180,7 @@ ___
 
 #### Defined in
 
-[src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
+[src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
 
 ___
 
@@ -194,7 +198,7 @@ ___
 
 #### Defined in
 
-[src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
+[src/StormError.ts:97](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L97)
 
 ___
 
@@ -212,7 +216,43 @@ ___
 
 #### Defined in
 
-[src/DiskSpaceError.ts:36](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L36)
+[src/DiskSpaceError.ts:36](https://github.com/breautek/storm/blob/0875c73/src/DiskSpaceError.ts#L36)
+
+___
+
+### getLocaleCode
+
+▸ **getLocaleCode**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
+
+#### Defined in
+
+[src/DiskSpaceError.ts:40](https://github.com/breautek/storm/blob/0875c73/src/DiskSpaceError.ts#L40)
+
+___
+
+### 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/0875c73/src/StormError.ts#L93)
 
 ___
 
@@ -230,7 +270,7 @@ ___
 
 #### Defined in
 
-[src/DiskSpaceError.ts:28](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L28)
+[src/DiskSpaceError.ts:28](https://github.com/breautek/storm/blob/0875c73/src/DiskSpaceError.ts#L28)
 
 ___
 
@@ -238,7 +278,7 @@ ___
 
 ▸ **getPrivateDetails**(): `any`
 
-Private details are only logged to the server log.
+Private details are only logged to the server log.
 They are kept secret from the client.
 
 #### Returns
@@ -251,7 +291,7 @@ They are kept secret from the client.
 
 #### Defined in
 
-[src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
+[src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
 
 ___
 
@@ -271,7 +311,7 @@ Sends details to the client.
 
 #### Defined in
 
-[src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
+[src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L60)
 
 ___
 
@@ -298,4 +338,4 @@ Create .stack property on a target object
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:4
+node_modules/@types/node/ts4.8/globals.d.ts:4

package/docs/classes/DropTemporaryTableQuery.md

@@ -42,7 +42,7 @@
 
 #### Defined in
 
-[src/Query.ts:22](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L22)
+[src/Query.ts:22](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L22)
 
 ## Methods
 
@@ -60,7 +60,7 @@
 
 #### Defined in
 
-[src/DropTemporaryTableQuery.ts:29](https://github.com/breautek/storm/blob/f198938/src/DropTemporaryTableQuery.ts#L29)
+[src/DropTemporaryTableQuery.ts:29](https://github.com/breautek/storm/blob/0875c73/src/DropTemporaryTableQuery.ts#L29)
 
 ___
 
@@ -84,7 +84,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:70](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L70)
+[src/Query.ts:70](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L70)
 
 ___
 
@@ -104,7 +104,7 @@ parameters that was passed into the constructor.
 
 #### Defined in
 
-[src/DropTemporaryTableQuery.ts:25](https://github.com/breautek/storm/blob/f198938/src/DropTemporaryTableQuery.ts#L25)
+[src/DropTemporaryTableQuery.ts:25](https://github.com/breautek/storm/blob/0875c73/src/DropTemporaryTableQuery.ts#L25)
 
 ___
 
@@ -126,7 +126,7 @@ parameters that will be used when this query is ran.
 
 #### Defined in
 
-[src/Query.ts:38](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L38)
+[src/Query.ts:38](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L38)
 
 ___
 
@@ -150,7 +150,7 @@ ___
 
 #### Defined in
 
-[src/Query.ts:44](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L44)
+[src/Query.ts:44](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L44)
 
 ___
 
@@ -177,7 +177,7 @@ Override to augment/manipulate the returned result set.
 
 #### Defined in
 
-[src/Query.ts:65](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L65)
+[src/Query.ts:65](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L65)
 
 ___
 
@@ -204,4 +204,4 @@ Can be used to set session variables or create temporary tables, etc.
 
 #### Defined in
 
-[src/Query.ts:55](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L55)
+[src/Query.ts:55](https://github.com/breautek/storm/blob/0875c73/src/Query.ts#L55)

package/docs/classes/DumpStream.md

@@ -20,4 +20,4 @@
 
 #### Defined in
 
-[src/DumpStream.ts:25](https://github.com/breautek/storm/blob/f198938/src/DumpStream.ts#L25)
+[src/DumpStream.ts:25](https://github.com/breautek/storm/blob/0875c73/src/DumpStream.ts#L25)