npm - @breautek/storm - Versions diffs - 4.3.0 → 4.4.0 - Mend

@breautek/storm 4.3.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

package/CHANGELOG.md +8 -0
package/docs/README.md +28 -20
package/docs/classes/Application.md +158 -76
package/docs/classes/BackendAuthenticationMiddleware.md +3 -3
package/docs/classes/CORSMiddleware.md +8 -8
package/docs/classes/ConfigLoader.md +1 -1
package/docs/classes/Database.md +12 -12
package/docs/classes/DatabaseConnection.md +42 -40
package/docs/classes/DatabaseQueryError.md +22 -18
package/docs/classes/DeadLockError.md +349 -0
package/docs/classes/DiskSpaceError.md +20 -18
package/docs/classes/DropTemporaryTableQuery.md +8 -8
package/docs/classes/DumpStream.md +1 -1
package/docs/classes/DuplicateEntryError.md +20 -18
package/docs/classes/EntityNotFoundError.md +20 -18
package/docs/classes/ExpiredTokenError.md +20 -18
package/docs/classes/Handler.md +14 -14
package/docs/classes/InternalError.md +20 -18
package/docs/classes/InvalidCredentialsError.md +20 -18
package/docs/classes/InvalidValueError.md +20 -18
package/docs/classes/ManagedDatabaseConnection.md +19 -19
package/docs/classes/Middleware.md +3 -3
package/docs/classes/MissingConfigError.md +20 -18
package/docs/classes/MissingParameterError.md +20 -18
package/docs/classes/MySQLConnection.md +73 -43
package/docs/classes/MySQLDatabase.md +13 -13
package/docs/classes/NotImplementedError.md +20 -18
package/docs/classes/Query.md +8 -8
package/docs/classes/RawError.md +20 -20
package/docs/classes/RawQuery.md +8 -8
package/docs/classes/Request.md +18 -18
package/docs/classes/Response.md +11 -11
package/docs/classes/ResponseData.md +7 -7
package/docs/classes/ServiceProvider.md +15 -15
package/docs/classes/ServiceResponse.md +4 -4
package/docs/classes/SetSessionVariableQuery.md +8 -8
package/docs/classes/StormError.md +20 -18
package/docs/classes/TemporaryTableQuery.md +8 -8
package/docs/classes/Token.md +2 -2
package/docs/classes/TokenManager.md +4 -4
package/docs/classes/UnauthorizedAccessError.md +20 -18
package/docs/enums/ErrorCode.md +18 -18
package/docs/enums/ExitCode.md +4 -4
package/docs/enums/HTTPMethod.md +8 -8
package/docs/enums/JWTError.md +4 -4
package/docs/enums/StatusCode.md +96 -96
package/docs/interfaces/IConfig.md +8 -8
package/docs/interfaces/IDatabaseConfig.md +6 -6
package/docs/interfaces/IDatabaseConnection.md +14 -14
package/docs/interfaces/IErrorResponse.md +5 -5
package/docs/interfaces/IFormData.md +2 -2
package/docs/interfaces/IHandler.md +1 -1
package/docs/interfaces/IInsertQueryResult.md +3 -3
package/docs/interfaces/IJWTVerifyOptions.md +1 -1
package/docs/interfaces/IRequestResponse.md +2 -2
package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
package/docs/interfaces/IUpdateQueryResult.md +2 -2
package/docs/interfaces/formidable.File.md +3 -1
package/docs/interfaces/formidable.FileJSON.md +3 -1
package/docs/interfaces/formidable.Options.md +33 -11
package/docs/interfaces/formidable.Part.md +65 -35
package/lib/DeadLockError.d.ts +6 -0
package/lib/DeadLockError.js +26 -0
package/lib/DeadLockError.js.map +1 -0
package/lib/MySQLConnection.js +9 -1
package/lib/MySQLConnection.js.map +1 -1
package/lib/api.d.ts +1 -0
package/lib/api.js +3 -1
package/lib/api.js.map +1 -1
package/package.json +19 -18
package/src/DeadLockError.ts +22 -0
package/src/MySQLConnection.ts +11 -1
package/src/api.ts +1 -0

package/docs/classes/MissingConfigError.md CHANGED Viewed

@@ -53,7 +53,7 @@
 #### Defined in
-[src/MissingConfigError.ts:27](https://github.com/breautek/storm/blob/4ac2f44/src/MissingConfigError.ts#L27)
+[src/MissingConfigError.ts:27](https://github.com/breautek/storm/blob/0875c73/src/MissingConfigError.ts#L27)
 ## Properties
@@ -67,7 +67,7 @@
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1029
+node_modules/typescript/lib/lib.es5.d.ts:1041
 ___
@@ -81,7 +81,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1028
+node_modules/typescript/lib/lib.es5.d.ts:1040
 ___
@@ -95,7 +95,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1030
+node_modules/typescript/lib/lib.es5.d.ts:1042
 ___
@@ -109,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
@@ -128,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
 ___
@@ -142,7 +144,7 @@ ___
 #### Defined in
-node_modules/@types/node/globals.d.ts:13
+node_modules/@types/node/ts4.8/globals.d.ts:13
 ## Methods
@@ -160,7 +162,7 @@ node_modules/@types/node/globals.d.ts:13
 #### Defined in
-[src/MissingConfigError.ts:37](https://github.com/breautek/storm/blob/4ac2f44/src/MissingConfigError.ts#L37)
+[src/MissingConfigError.ts:37](https://github.com/breautek/storm/blob/0875c73/src/MissingConfigError.ts#L37)
 ___
@@ -178,7 +180,7 @@ ___
 #### Defined in
-[src/StormError.ts:76](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L76)
+[src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
 ___
@@ -196,7 +198,7 @@ ___
 #### Defined in
-[src/MissingConfigError.ts:45](https://github.com/breautek/storm/blob/4ac2f44/src/MissingConfigError.ts#L45)
+[src/MissingConfigError.ts:45](https://github.com/breautek/storm/blob/0875c73/src/MissingConfigError.ts#L45)
 ___
@@ -214,7 +216,7 @@ ___
 #### Defined in
-[src/MissingConfigError.ts:41](https://github.com/breautek/storm/blob/4ac2f44/src/MissingConfigError.ts#L41)
+[src/MissingConfigError.ts:41](https://github.com/breautek/storm/blob/0875c73/src/MissingConfigError.ts#L41)
 ___
@@ -232,7 +234,7 @@ ___
 #### Defined in
-[src/MissingConfigError.ts:49](https://github.com/breautek/storm/blob/4ac2f44/src/MissingConfigError.ts#L49)
+[src/MissingConfigError.ts:49](https://github.com/breautek/storm/blob/0875c73/src/MissingConfigError.ts#L49)
 ___
@@ -250,7 +252,7 @@ ___
 #### Defined in
-[src/MissingConfigError.ts:53](https://github.com/breautek/storm/blob/4ac2f44/src/MissingConfigError.ts#L53)
+[src/MissingConfigError.ts:53](https://github.com/breautek/storm/blob/0875c73/src/MissingConfigError.ts#L53)
 ___
@@ -268,7 +270,7 @@ ___
 #### Defined in
-[src/MissingConfigError.ts:33](https://github.com/breautek/storm/blob/4ac2f44/src/MissingConfigError.ts#L33)
+[src/MissingConfigError.ts:33](https://github.com/breautek/storm/blob/0875c73/src/MissingConfigError.ts#L33)
 ___
@@ -276,7 +278,7 @@ ___
 ▸ **getPrivateDetails**(): `IMissingConfigErrorDetails`
-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
@@ -289,7 +291,7 @@ They are kept secret from the client.
 #### Defined in
-[src/StormError.ts:68](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L68)
+[src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
 ___
@@ -309,7 +311,7 @@ Sends details to the client.
 #### Defined in
-[src/StormError.ts:60](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L60)
+[src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L60)
 ___
@@ -336,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/MissingParameterError.md CHANGED Viewed

@@ -53,7 +53,7 @@
 #### Defined in
-[src/MissingParameterError.ts:22](https://github.com/breautek/storm/blob/4ac2f44/src/MissingParameterError.ts#L22)
+[src/MissingParameterError.ts:22](https://github.com/breautek/storm/blob/0875c73/src/MissingParameterError.ts#L22)
 ## Properties
@@ -67,7 +67,7 @@
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1029
+node_modules/typescript/lib/lib.es5.d.ts:1041
 ___
@@ -81,7 +81,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1028
+node_modules/typescript/lib/lib.es5.d.ts:1040
 ___
@@ -95,7 +95,7 @@ ___
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1030
+node_modules/typescript/lib/lib.es5.d.ts:1042
 ___
@@ -109,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
@@ -128,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
 ___
@@ -142,7 +144,7 @@ ___
 #### Defined in
-node_modules/@types/node/globals.d.ts:13
+node_modules/@types/node/ts4.8/globals.d.ts:13
 ## Methods
@@ -160,7 +162,7 @@ node_modules/@types/node/globals.d.ts:13
 #### Defined in
-[src/MissingParameterError.ts:30](https://github.com/breautek/storm/blob/4ac2f44/src/MissingParameterError.ts#L30)
+[src/MissingParameterError.ts:30](https://github.com/breautek/storm/blob/0875c73/src/MissingParameterError.ts#L30)
 ___
@@ -178,7 +180,7 @@ ___
 #### Defined in
-[src/StormError.ts:76](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L76)
+[src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
 ___
@@ -196,7 +198,7 @@ ___
 #### Defined in
-[src/StormError.ts:97](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L97)
+[src/StormError.ts:97](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L97)
 ___
@@ -214,7 +216,7 @@ ___
 #### Defined in
-[src/MissingParameterError.ts:34](https://github.com/breautek/storm/blob/4ac2f44/src/MissingParameterError.ts#L34)
+[src/MissingParameterError.ts:34](https://github.com/breautek/storm/blob/0875c73/src/MissingParameterError.ts#L34)
 ___
@@ -232,7 +234,7 @@ ___
 #### Defined in
-[src/MissingParameterError.ts:38](https://github.com/breautek/storm/blob/4ac2f44/src/MissingParameterError.ts#L38)
+[src/MissingParameterError.ts:38](https://github.com/breautek/storm/blob/0875c73/src/MissingParameterError.ts#L38)
 ___
@@ -250,7 +252,7 @@ ___
 #### Defined in
-[src/MissingParameterError.ts:42](https://github.com/breautek/storm/blob/4ac2f44/src/MissingParameterError.ts#L42)
+[src/MissingParameterError.ts:42](https://github.com/breautek/storm/blob/0875c73/src/MissingParameterError.ts#L42)
 ___
@@ -268,7 +270,7 @@ ___
 #### Defined in
-[src/MissingParameterError.ts:26](https://github.com/breautek/storm/blob/4ac2f44/src/MissingParameterError.ts#L26)
+[src/MissingParameterError.ts:26](https://github.com/breautek/storm/blob/0875c73/src/MissingParameterError.ts#L26)
 ___
@@ -276,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
@@ -289,7 +291,7 @@ They are kept secret from the client.
 #### Defined in
-[src/StormError.ts:68](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L68)
+[src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
 ___
@@ -309,7 +311,7 @@ Sends details to the client.
 #### Defined in
-[src/StormError.ts:60](https://github.com/breautek/storm/blob/4ac2f44/src/StormError.ts#L60)
+[src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L60)
 ___
@@ -336,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/MySQLConnection.md CHANGED Viewed

@@ -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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/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/4ac2f44/src/DatabaseConnection.ts#L151)
+[src/DatabaseConnection.ts:151](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L151)