@breautek/storm 4.2.0 → 4.4.0

package/docs/classes/MySQLConnection.md

@@ -2,6 +2,14 @@
 
 # Class: MySQLConnection
 
+Do not call `new Database` directly. Use `Database.getConnection` to create a `DatabaseConnection` object.
+
+**`Abstract`**
+
+**`Implements`**
+
+`IDatabaseConnection`
+
 ## Hierarchy
 
 - [`DatabaseConnection`](DatabaseConnection.md)<`MySQL.PoolConnection`\>
@@ -56,7 +64,7 @@
 
 #### Defined in
 
-[src/MySQLConnection.ts:46](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L46)
+[src/MySQLConnection.ts:48](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L48)
 
 ## Methods
 
@@ -64,14 +72,16 @@
 
 ▸ `Protected` **_close**(`forceClose`): `Promise`<`void`\>
 
-Implementation to close the connection, if `forceClose` is true, close the connection no matter what.
+Implementation to close the connection, if `forceClose` is true, close the connection no matter what.
 Silently error if it means the connection is closed.
 
+**`Async`**
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `forceClose` | `boolean` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `forceClose` | `boolean` | boolean, if `true`, should close the connection no matter what. |
 
 #### Returns
 
@@ -85,7 +95,7 @@ Promise<void>
 
 #### Defined in
 
-[src/MySQLConnection.ts:190](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L190)
+[src/MySQLConnection.ts:200](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L200)
 
 ___
 
@@ -95,12 +105,14 @@ ___
 
 Implementation method to return a dataset from the database
 
+**`Async`**
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `params?` | `any` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `query` | `string` | The database query |
+| `params?` | `any` | The query parameters |
 
 #### Returns
 
@@ -114,7 +126,7 @@ Promise
 
 #### Defined in
 
-[src/MySQLConnection.ts:74](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L74)
+[src/MySQLConnection.ts:76](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L76)
 
 ___
 
@@ -122,16 +134,16 @@ ___
 
 ▸ `Protected` **_stream**(`query`, `params?`, `streamOptions?`): `Readable`
 
-Implementation method to return a dataset from the database like `query()`,
+Implementation method to return a dataset from the database like `query()`,
 but returns a `Readable` stream instead.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `params?` | `any` |
-| `streamOptions?` | `any` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `query` | `string` | The database query |
+| `params?` | `any` | The query parameters |
+| `streamOptions?` | `any` | `Readable` stream options |
 
 #### Returns
 
@@ -145,7 +157,7 @@ but returns a `Readable` stream instead.
 
 #### Defined in
 
-[src/MySQLConnection.ts:113](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L113)
+[src/MySQLConnection.ts:123](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L123)
 
 ___
 
@@ -153,11 +165,11 @@ ___
 
 ▸ **close**(`forceClose?`): `Promise`<`void`\>
 
-Closes the connection. May error if connection has an active transaction.
-if `forceClose` boolean is true, it will force close the connection, regardless
+Closes the connection. May error if connection has an active transaction.
+if `forceClose` boolean is true, it will force close the connection, regardless
 of transaction state.
 
-**`async`**
+**`Async`**
 
 #### Parameters
 
@@ -177,7 +189,7 @@ Promise<void>
 
 #### Defined in
 
-[src/DatabaseConnection.ts:168](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L168)
+[src/DatabaseConnection.ts:168](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L168)
 
 ___
 
@@ -187,6 +199,10 @@ ___
 
 Commits a transaction. This will end a transaction.
 
+**`Abstract`**
+
+**`Async`**
+
 #### Returns
 
 `Promise`<`void`\>
@@ -199,7 +215,7 @@ Promise<void>
 
 #### Defined in
 
-[src/MySQLConnection.ts:174](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L174)
+[src/MySQLConnection.ts:184](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L184)
 
 ___
 
@@ -209,11 +225,15 @@ ___
 
 Ends a transaction. if `requiresRollback` is `true`, then `rollback()` is invoked. Otherwise, `commit()` is invoked.
 
+**`Abstract`**
+
+**`Async`**
+
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `requiresRollback` | `boolean` | `false` |
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `requiresRollback` | `boolean` | `false` | optional boolean |
 
 #### Returns
 
@@ -227,7 +247,7 @@ Promise<void>
 
 #### Defined in
 
-[src/MySQLConnection.ts:154](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L154)
+[src/MySQLConnection.ts:164](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L164)
 
 ___
 
@@ -249,7 +269,7 @@ any
 
 #### Defined in
 
-[src/DatabaseConnection.ts:90](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L90)
+[src/DatabaseConnection.ts:90](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L90)
 
 ___
 
@@ -257,7 +277,7 @@ ___
 
 ▸ **getInstantiationStack**(): `string`
 
-Gets the callback stacktrace to determine what opened
+Gets the callback stacktrace to determine what opened
 this connection. Useful for debugging lingering connections.
 
 #### Returns
@@ -272,7 +292,7 @@ string - A stacktrace
 
 #### Defined in
 
-[src/DatabaseConnection.ts:72](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L72)
+[src/DatabaseConnection.ts:72](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L72)
 
 ___
 
@@ -294,7 +314,7 @@ number in milliseconds
 
 #### Defined in
 
-[src/DatabaseConnection.ts:120](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L120)
+[src/DatabaseConnection.ts:120](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L120)
 
 ___
 
@@ -314,7 +334,7 @@ Returns true if the connection has been closed.
 
 #### Defined in
 
-[src/DatabaseConnection.ts:181](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L181)
+[src/DatabaseConnection.ts:181](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L181)
 
 ___
 
@@ -328,7 +348,7 @@ ___
 
 #### Defined in
 
-[src/MySQLConnection.ts:69](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L69)
+[src/MySQLConnection.ts:71](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L71)
 
 ___
 
@@ -336,7 +356,7 @@ ___
 
 ▸ **isReadOnly**(): `boolean`
 
-Returns true if connection was created without
+Returns true if connection was created without
 write access
 
 #### Returns
@@ -351,7 +371,7 @@ boolean
 
 #### Defined in
 
-[src/DatabaseConnection.ts:99](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L99)
+[src/DatabaseConnection.ts:99](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L99)
 
 ___
 
@@ -361,6 +381,8 @@ ___
 
 Implementation method to determine if the connection is in an active transaction.
 
+**`Abstract`**
+
 #### Returns
 
 `boolean`
@@ -373,7 +395,7 @@ boolean
 
 #### Defined in
 
-[src/MySQLConnection.ts:65](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L65)
+[src/MySQLConnection.ts:67](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L67)
 
 ___
 
@@ -383,7 +405,7 @@ ___
 
 Queries the database for a dataset.
 
-**`async`**
+**`Async`**
 
 #### Type parameters
 
@@ -409,7 +431,7 @@ Promise<TQueryResult>
 
 #### Defined in
 
-[src/DatabaseConnection.ts:131](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L131)
+[src/DatabaseConnection.ts:131](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L131)
 
 ___
 
@@ -419,6 +441,10 @@ ___
 
 Rollsback a transaction. This will end a transaction.
 
+**`Abstract`**
+
+**`Async`**
+
 #### Returns
 
 `Promise`<`void`\>
@@ -431,7 +457,7 @@ Promise<void>
 
 #### Defined in
 
-[src/MySQLConnection.ts:158](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L158)
+[src/MySQLConnection.ts:168](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L168)
 
 ___
 
@@ -455,7 +481,7 @@ ___
 
 #### Defined in
 
-[src/DatabaseConnection.ts:63](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L63)
+[src/DatabaseConnection.ts:63](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L63)
 
 ___
 
@@ -481,7 +507,7 @@ Sets the timeout of this connectino
 
 #### Defined in
 
-[src/DatabaseConnection.ts:108](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L108)
+[src/DatabaseConnection.ts:108](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L108)
 
 ___
 
@@ -491,6 +517,10 @@ ___
 
 Implementation method to start a transaction.
 
+**`Abstract`**
+
+**`Async`**
+
 #### Returns
 
 `Promise`<`void`\>
@@ -503,7 +533,7 @@ Promise<void>
 
 #### Defined in
 
-[src/MySQLConnection.ts:132](https://github.com/breautek/storm/blob/f198938/src/MySQLConnection.ts#L132)
+[src/MySQLConnection.ts:142](https://github.com/breautek/storm/blob/0875c73/src/MySQLConnection.ts#L142)
 
 ___
 
@@ -530,4 +560,4 @@ Readable
 
 #### Defined in
 
-[src/DatabaseConnection.ts:151](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L151)
+[src/DatabaseConnection.ts:151](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L151)

package/docs/classes/MySQLDatabase.md

@@ -41,7 +41,7 @@
 
 #### Defined in
 
-[src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/f198938/src/MySQLDatabase.ts#L27)
+[src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L27)
 
 ## Methods
 
@@ -66,7 +66,7 @@
 
 #### Defined in
 
-[src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/f198938/src/MySQLDatabase.ts#L49)
+[src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L49)
 
 ___
 
@@ -84,7 +84,7 @@ ___
 
 #### Defined in
 
-[src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/f198938/src/MySQLDatabase.ts#L59)
+[src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L59)
 
 ___
 
@@ -109,7 +109,7 @@ ___
 
 #### Defined in
 
-[src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/f198938/src/MySQLDatabase.ts#L72)
+[src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L72)
 
 ___
 
@@ -133,7 +133,7 @@ ___
 
 #### Defined in
 
-[src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/f198938/src/MySQLDatabase.ts#L54)
+[src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L54)
 
 ___
 
@@ -157,7 +157,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:31](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L31)
+[src/Database.ts:31](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L31)
 
 ___
 
@@ -182,7 +182,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:45](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L45)
+[src/Database.ts:45](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L45)
 
 ___
 
@@ -200,7 +200,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:77](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L77)
+[src/Database.ts:77](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L77)
 
 ___
 
@@ -224,7 +224,7 @@ ___
 
 #### Defined in
 
-[src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/f198938/src/MySQLDatabase.ts#L40)
+[src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L40)
 
 ___
 
@@ -249,7 +249,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:64](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L64)
+[src/Database.ts:64](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L64)
 
 ___
 
@@ -267,7 +267,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:40](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L40)
+[src/Database.ts:40](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L40)
 
 ___
 
@@ -291,7 +291,7 @@ ___
 
 #### Defined in
 
-[src/Database.ts:54](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L54)
+[src/Database.ts:54](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L54)
 
 ___
 
@@ -311,4 +311,4 @@ ___
 
 #### Defined in
 
-[src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/f198938/src/MySQLDatabase.ts#L45)
+[src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/0875c73/src/MySQLDatabase.ts#L45)

package/docs/classes/NotImplementedError.md

@@ -28,6 +28,8 @@
 - [getErrorResponse](NotImplementedError.md#geterrorresponse)
 - [getExitCode](NotImplementedError.md#getexitcode)
 - [getHTTPCode](NotImplementedError.md#gethttpcode)
+- [getLocaleCode](NotImplementedError.md#getlocalecode)
+- [getLocaleParameters](NotImplementedError.md#getlocaleparameters)
 - [getMessage](NotImplementedError.md#getmessage)
 - [getPrivateDetails](NotImplementedError.md#getprivatedetails)
 - [getPublicDetails](NotImplementedError.md#getpublicdetails)
@@ -51,7 +53,7 @@
 
 #### Defined in
 
-[src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/f198938/src/NotImplementedError.ts#L27)
+[src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L27)
 
 ## 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/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/f198938/src/NotImplementedError.ts#L38)
+[src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L38)
 
 ___
 
@@ -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/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/f198938/src/NotImplementedError.ts#L42)
+[src/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L42)
+
+___
+
+### getLocaleCode
+
+▸ **getLocaleCode**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
+
+#### Defined in
+
+[src/NotImplementedError.ts:46](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L46)
+
+___
+
+### getLocaleParameters
+
+▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
+
+#### Returns
+
+`Record`<`string`, `string`\>
+
+#### Overrides
+
+[StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
+
+#### Defined in
+
+[src/NotImplementedError.ts:50](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L50)
 
 ___
 
@@ -230,7 +270,7 @@ ___
 
 #### Defined in
 
-[src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/f198938/src/NotImplementedError.ts#L33)
+[src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/0875c73/src/NotImplementedError.ts#L33)
 
 ___
 
@@ -238,7 +278,7 @@ ___
 
 ▸ **getPrivateDetails**(): `INotImplementedErrorOptions`
 
-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