npm - @breautek/storm - Versions diffs - 5.0.1 → 5.0.2 - Mend

@breautek/storm 5.0.1 → 5.0.2

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 (183) hide show

package/CHANGELOG.md +10 -2
package/docs/assets/highlight.css +85 -0
package/docs/assets/main.js +58 -0
package/docs/assets/search.js +1 -0
package/docs/assets/style.css +1367 -0
package/docs/classes/Application.html +1235 -0
package/docs/classes/BackendAuthenticationMiddleware.html +191 -0
package/docs/classes/CORSMiddleware.html +257 -0
package/docs/classes/ConfigLoader.html +166 -0
package/docs/classes/Database.html +340 -0
package/docs/classes/DatabaseCastObject.html +203 -0
package/docs/classes/DatabaseConnection.html +550 -0
package/docs/classes/DatabaseQueryError.html +372 -0
package/docs/classes/DeadLockError.html +372 -0
package/docs/classes/DiskSpaceError.html +362 -0
package/docs/classes/DropTemporaryTableQuery.html +285 -0
package/docs/classes/DumpStream.html +161 -0
package/docs/classes/DuplicateEntryError.html +366 -0
package/docs/classes/EntityNotFoundError.html +362 -0
package/docs/classes/ExpiredTokenError.html +362 -0
package/docs/classes/Handler.html +395 -0
package/docs/classes/InternalError.html +362 -0
package/docs/classes/InvalidCredentialsError.html +362 -0
package/docs/classes/InvalidValueError.html +373 -0
package/docs/classes/LineString.html +212 -0
package/docs/classes/LockWaitTimeoutError.html +372 -0
package/docs/classes/ManagedDatabaseConnection.html +410 -0
package/docs/classes/Middleware.html +202 -0
package/docs/classes/MissingConfigError.html +362 -0
package/docs/classes/MissingParameterError.html +362 -0
package/docs/classes/MySQLConnection.html +546 -0
package/docs/classes/MySQLDatabase.html +353 -0
package/docs/classes/NotImplementedError.html +362 -0
package/docs/classes/Point.html +214 -0
package/docs/classes/Polygon.html +212 -0
package/docs/classes/Query.html +312 -0
package/docs/classes/RawError.html +374 -0
package/docs/classes/RawQuery.html +305 -0
package/docs/classes/Request.html +375 -0
package/docs/classes/Response.html +329 -0
package/docs/classes/ResponseData.html +255 -0
package/docs/classes/ServiceProvider.html +385 -0
package/docs/classes/ServiceResponse.html +213 -0
package/docs/classes/SetSessionVariableQuery.html +285 -0
package/docs/classes/StormError.html +377 -0
package/docs/classes/TemporaryTableQuery.html +290 -0
package/docs/classes/Token.html +181 -0
package/docs/classes/TokenManager.html +233 -0
package/docs/classes/Transaction.html +267 -0
package/docs/classes/UnauthorizedAccessError.html +362 -0
package/docs/enums/ErrorCode.html +210 -0
package/docs/enums/ExitCode.html +161 -0
package/docs/enums/HTTPMethod.html +175 -0
package/docs/enums/IsolationLevel.html +175 -0
package/docs/enums/JWTError.html +161 -0
package/docs/enums/StatusCode.html +483 -0
package/docs/functions/formidable-1.html +143 -0
package/docs/functions/getInstance.html +138 -0
package/docs/index.html +224 -0
package/docs/interfaces/IAdditionalErrorDetails.html +140 -0
package/docs/interfaces/IAuthTokenData.html +172 -0
package/docs/interfaces/IConfig.html +225 -0
package/docs/interfaces/IDatabaseConfig.html +198 -0
package/docs/interfaces/IDatabaseConnection.html +332 -0
package/docs/interfaces/IErrorResponse.html +186 -0
package/docs/interfaces/IFormData.html +165 -0
package/docs/interfaces/IHandler.html +171 -0
package/docs/interfaces/IInsertQueryResult.html +172 -0
package/docs/interfaces/IJWTVerifyOptions.html +158 -0
package/docs/interfaces/IParameterMap.html +140 -0
package/docs/interfaces/IQueryable.html +233 -0
package/docs/interfaces/IRequestResponse.html +172 -0
package/docs/interfaces/IServiceHeaders.html +140 -0
package/docs/interfaces/ISetSessionVariableQueryInput.html +165 -0
package/docs/interfaces/ITemporaryTableQueryInput.html +165 -0
package/docs/interfaces/IUpdateQueryResult.html +165 -0
package/docs/interfaces/formidable.EmitData.html +180 -0
package/docs/interfaces/formidable.EventData.html +201 -0
package/docs/interfaces/formidable.Fields.html +141 -0
package/docs/interfaces/formidable.File.html +239 -0
package/docs/interfaces/formidable.FileJSON.html +238 -0
package/docs/interfaces/formidable.Files.html +141 -0
package/docs/interfaces/formidable.Options.html +308 -0
package/docs/interfaces/formidable.Part.html +691 -0
package/docs/modules/formidable.html +159 -0
package/docs/types/IDeleteQueryResult.html +134 -0
package/docs/types/IHandlerError.html +139 -0
package/docs/types/IHandlerResponse.html +145 -0
package/docs/types/TCoordinate.html +134 -0
package/docs/types/formidable.BufferEncoding.html +135 -0
package/docs/types/formidable.DefaultOptions.html +135 -0
package/docs/types/formidable.EnabledPlugins.html +135 -0
package/docs/types/formidable.EventNames.html +135 -0
package/docs/types/formidable.MappedParsers.html +135 -0
package/docs/types/formidable.Plugin.html +135 -0
package/docs/types/formidable.PluginFunction.html +150 -0
package/docs/types/formidable.Plugins.html +135 -0
package/lib/StatusCode.d.ts +1 -1
package/lib/StatusCode.js +1 -1
package/lib/Transaction.d.ts +4 -0
package/lib/Transaction.js +4 -0
package/lib/Transaction.js.map +1 -1
package/package.json +14 -14
package/src/StatusCode.ts +1 -1
package/src/Transaction.ts +4 -0
package/docs/README.md +0 -188
package/docs/classes/Application.md +0 -1648
package/docs/classes/BackendAuthenticationMiddleware.md +0 -49
package/docs/classes/CORSMiddleware.md +0 -143
package/docs/classes/ConfigLoader.md +0 -29
package/docs/classes/Database.md +0 -259
package/docs/classes/DatabaseCastObject.md +0 -79
package/docs/classes/DatabaseConnection.md +0 -556
package/docs/classes/DatabaseQueryError.md +0 -351
package/docs/classes/DeadLockError.md +0 -349
package/docs/classes/DiskSpaceError.md +0 -341
package/docs/classes/DropTemporaryTableQuery.md +0 -207
package/docs/classes/DumpStream.md +0 -23
package/docs/classes/DuplicateEntryError.md +0 -343
package/docs/classes/EntityNotFoundError.md +0 -341
package/docs/classes/ExpiredTokenError.md +0 -341
package/docs/classes/Handler.md +0 -302
package/docs/classes/InternalError.md +0 -341
package/docs/classes/InvalidCredentialsError.md +0 -341
package/docs/classes/InvalidValueError.md +0 -349
package/docs/classes/LineString.md +0 -101
package/docs/classes/LockWaitTimeoutError.md +0 -349
package/docs/classes/ManagedDatabaseConnection.md +0 -403
package/docs/classes/Middleware.md +0 -72
package/docs/classes/MissingConfigError.md +0 -341
package/docs/classes/MissingParameterError.md +0 -341
package/docs/classes/MySQLConnection.md +0 -569
package/docs/classes/MySQLDatabase.md +0 -314
package/docs/classes/NotImplementedError.md +0 -341
package/docs/classes/Point.md +0 -102
package/docs/classes/Polygon.md +0 -101
package/docs/classes/Query.md +0 -227
package/docs/classes/RawError.md +0 -351
package/docs/classes/RawQuery.md +0 -224
package/docs/classes/Request.md +0 -321
package/docs/classes/Response.md +0 -242
package/docs/classes/ResponseData.md +0 -144
package/docs/classes/ServiceProvider.md +0 -296
package/docs/classes/ServiceResponse.md +0 -89
package/docs/classes/SetSessionVariableQuery.md +0 -207
package/docs/classes/StormError.md +0 -343
package/docs/classes/TemporaryTableQuery.md +0 -213
package/docs/classes/Token.md +0 -43
package/docs/classes/TokenManager.md +0 -105
package/docs/classes/Transaction.md +0 -161
package/docs/classes/UnauthorizedAccessError.md +0 -341
package/docs/enums/ErrorCode.md +0 -107
package/docs/enums/ExitCode.md +0 -30
package/docs/enums/HTTPMethod.md +0 -52
package/docs/enums/IsolationLevel.md +0 -52
package/docs/enums/JWTError.md +0 -30
package/docs/enums/StatusCode.md +0 -536
package/docs/interfaces/IAdditionalErrorDetails.md +0 -7
package/docs/interfaces/IAuthTokenData.md +0 -41
package/docs/interfaces/IConfig.md +0 -112
package/docs/interfaces/IDatabaseConfig.md +0 -80
package/docs/interfaces/IDatabaseConnection.md +0 -262
package/docs/interfaces/IErrorResponse.md +0 -63
package/docs/interfaces/IFormData.md +0 -30
package/docs/interfaces/IHandler.md +0 -31
package/docs/interfaces/IInsertQueryResult.md +0 -41
package/docs/interfaces/IJWTVerifyOptions.md +0 -19
package/docs/interfaces/IParameterMap.md +0 -7
package/docs/interfaces/IQueryable.md +0 -119
package/docs/interfaces/IRequestResponse.md +0 -37
package/docs/interfaces/IServiceHeaders.md +0 -7
package/docs/interfaces/ISetSessionVariableQueryInput.md +0 -30
package/docs/interfaces/ITemporaryTableQueryInput.md +0 -30
package/docs/interfaces/IUpdateQueryResult.md +0 -30
package/docs/interfaces/formidable.EmitData.md +0 -54
package/docs/interfaces/formidable.EventData.md +0 -87
package/docs/interfaces/formidable.Fields.md +0 -9
package/docs/interfaces/formidable.File.md +0 -131
package/docs/interfaces/formidable.FileJSON.md +0 -151
package/docs/interfaces/formidable.Files.md +0 -9
package/docs/interfaces/formidable.Options.md +0 -225
package/docs/interfaces/formidable.Part.md +0 -793
package/docs/modules/formidable.md +0 -122

package/docs/classes/InvalidValueError.md DELETED Viewed

@@ -1,349 +0,0 @@
-[@breautek/storm](../README.md) / InvalidValueError
-# Class: InvalidValueError
-## Hierarchy
-- [`StormError`](StormError.md)<{ `expected`: `any` ; `got`: `any` ; `variable`: `string`  }\>
-  ↳ **`InvalidValueError`**
-## Table of contents
-### Constructors
-- [constructor](InvalidValueError.md#constructor)
-### Properties
-- [message](InvalidValueError.md#message)
-- [name](InvalidValueError.md#name)
-- [stack](InvalidValueError.md#stack)
-- [prepareStackTrace](InvalidValueError.md#preparestacktrace)
-- [stackTraceLimit](InvalidValueError.md#stacktracelimit)
-### Methods
-- [getCode](InvalidValueError.md#getcode)
-- [getErrorResponse](InvalidValueError.md#geterrorresponse)
-- [getExitCode](InvalidValueError.md#getexitcode)
-- [getHTTPCode](InvalidValueError.md#gethttpcode)
-- [getLocaleCode](InvalidValueError.md#getlocalecode)
-- [getLocaleParameters](InvalidValueError.md#getlocaleparameters)
-- [getMessage](InvalidValueError.md#getmessage)
-- [getPrivateDetails](InvalidValueError.md#getprivatedetails)
-- [getPublicDetails](InvalidValueError.md#getpublicdetails)
-- [captureStackTrace](InvalidValueError.md#capturestacktrace)
-## Constructors
-### constructor
-• **new InvalidValueError**(`variable`, `expected`, `got`)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `variable` | `string` |
-| `expected` | `any` |
-| `got` | `any` |
-#### Overrides
-[StormError](StormError.md).[constructor](StormError.md#constructor)
-#### Defined in
-[src/InvalidValueError.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/InvalidValueError.ts#L27)
-## Properties
-### message
-• **message**: `string`
-#### Inherited from
-[StormError](StormError.md).[message](StormError.md#message)
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1054
-___
-### name
-• **name**: `string`
-#### Inherited from
-[StormError](StormError.md).[name](StormError.md#name)
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1053
-___
-### stack
-• `Optional` **stack**: `string`
-#### Inherited from
-[StormError](StormError.md).[stack](StormError.md#stack)
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1055
-___
-### 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/InvalidValueError.ts:40](https://github.com/breautek/storm/blob/3dcafe4/src/InvalidValueError.ts#L40)
-___
-### 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/3dcafe4/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/3dcafe4/src/StormError.ts#L97)
-___
-### getHTTPCode
-▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
-#### Returns
-[`StatusCode`](../enums/StatusCode.md)
-#### Overrides
-[StormError](StormError.md).[getHTTPCode](StormError.md#gethttpcode)
-#### Defined in
-[src/InvalidValueError.ts:44](https://github.com/breautek/storm/blob/3dcafe4/src/InvalidValueError.ts#L44)
-___
-### getLocaleCode
-▸ **getLocaleCode**(): `string`
-#### Returns
-`string`
-#### Overrides
-[StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
-#### Defined in
-[src/InvalidValueError.ts:48](https://github.com/breautek/storm/blob/3dcafe4/src/InvalidValueError.ts#L48)
-___
-### getLocaleParameters
-▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
-#### Returns
-`Record`<`string`, `string`\>
-#### Overrides
-[StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
-#### Defined in
-[src/InvalidValueError.ts:52](https://github.com/breautek/storm/blob/3dcafe4/src/InvalidValueError.ts#L52)
-___
-### getMessage
-▸ **getMessage**(): `string`
-#### Returns
-`string`
-#### Overrides
-[StormError](StormError.md).[getMessage](StormError.md#getmessage)
-#### Defined in
-[src/InvalidValueError.ts:35](https://github.com/breautek/storm/blob/3dcafe4/src/InvalidValueError.ts#L35)
-___
-### getPrivateDetails
-▸ **getPrivateDetails**(): `Object`
-Private details are only logged to the server log.
-They are kept secret from the client.
-#### Returns
-`Object`
-| Name | Type |
-| :------ | :------ |
-| `expected` | `any` |
-| `got` | `any` |
-| `variable` | `string` |
-#### Inherited from
-[StormError](StormError.md).[getPrivateDetails](StormError.md#getprivatedetails)
-#### Defined in
-[src/StormError.ts:68](https://github.com/breautek/storm/blob/3dcafe4/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/3dcafe4/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/LineString.md DELETED Viewed

@@ -1,101 +0,0 @@
-[@breautek/storm](../README.md) / LineString
-# Class: LineString
-## Hierarchy
-- [`DatabaseCastObject`](DatabaseCastObject.md)
-  ↳ **`LineString`**
-## Table of contents
-### Constructors
-- [constructor](LineString.md#constructor)
-### Methods
-- [\_toSQLString](LineString.md#_tosqlstring)
-- [escape](LineString.md#escape)
-- [toSqlString](LineString.md#tosqlstring)
-## Constructors
-### constructor
-• **new LineString**(`coordinates?`)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `coordinates?` | [`TCoordinate`](../README.md#tcoordinate)[] |
-#### Overrides
-[DatabaseCastObject](DatabaseCastObject.md).[constructor](DatabaseCastObject.md#constructor)
-#### Defined in
-[src/LineString.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/LineString.ts#L23)
-## Methods
-### \_toSQLString
-▸ `Protected` **_toSQLString**(): `string`
-#### Returns
-`string`
-#### Overrides
-[DatabaseCastObject](DatabaseCastObject.md).[_toSQLString](DatabaseCastObject.md#_tosqlstring)
-#### Defined in
-[src/LineString.ts:29](https://github.com/breautek/storm/blob/3dcafe4/src/LineString.ts#L29)
-___
-### escape
-▸ **escape**(`value`): `string`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-#### Returns
-`string`
-#### Inherited from
-[DatabaseCastObject](DatabaseCastObject.md).[escape](DatabaseCastObject.md#escape)
-#### Defined in
-[src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L24)
-___
-### toSqlString
-▸ **toSqlString**(): `string`
-#### Returns
-`string`
-#### Inherited from
-[DatabaseCastObject](DatabaseCastObject.md).[toSqlString](DatabaseCastObject.md#tosqlstring)
-#### Defined in
-[src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L20)