@breautek/storm 3.3.1 → 4.1.0

package/docs/modules/api.md

@@ -1,439 +0,0 @@
-[@breautek/storm](../README.md) / api
-
-# Module: api
-
-## Table of contents
-
-### References
-
-- [Application](api.md#application)
-- [BackendAuthenticationMiddleware](api.md#backendauthenticationmiddleware)
-- [CORSMiddleware](api.md#corsmiddleware)
-- [ConfigLoader](api.md#configloader)
-- [Database](api.md#database)
-- [DatabaseConnection](api.md#databaseconnection)
-- [DatabaseQueryError](api.md#databasequeryerror)
-- [DiskSpaceError](api.md#diskspaceerror)
-- [DropTemporaryTableQuery](api.md#droptemporarytablequery)
-- [DumpStream](api.md#dumpstream)
-- [DuplicateEntryError](api.md#duplicateentryerror)
-- [EntityNotFoundError](api.md#entitynotfounderror)
-- [ErrorCode](api.md#errorcode)
-- [ExitCode](api.md#exitcode)
-- [ExpiredTokenError](api.md#expiredtokenerror)
-- [HTTPMethod](api.md#httpmethod)
-- [Handler](api.md#handler)
-- [IAdditionalErrorDetails](api.md#iadditionalerrordetails)
-- [IAuthTokenData](api.md#iauthtokendata)
-- [IConfig](api.md#iconfig)
-- [IDatabaseConfig](api.md#idatabaseconfig)
-- [IDatabaseConnection](api.md#idatabaseconnection)
-- [IDeleteQueryResult](api.md#ideletequeryresult)
-- [IErrorResponse](api.md#ierrorresponse)
-- [IFormData](api.md#iformdata)
-- [IHandler](api.md#ihandler)
-- [IHandlerError](api.md#ihandlererror)
-- [IHandlerResponse](api.md#ihandlerresponse)
-- [IInsertQueryResult](api.md#iinsertqueryresult)
-- [IJWTVerifyOptions](api.md#ijwtverifyoptions)
-- [IParameterMap](api.md#iparametermap)
-- [IRequestResponse](api.md#irequestresponse)
-- [IServiceHeaders](api.md#iserviceheaders)
-- [ITemporaryTableQueryInput](api.md#itemporarytablequeryinput)
-- [IUpdateQueryResult](api.md#iupdatequeryresult)
-- [InternalError](api.md#internalerror)
-- [InvalidCredentialsError](api.md#invalidcredentialserror)
-- [InvalidValueError](api.md#invalidvalueerror)
-- [JWTError](api.md#jwterror)
-- [ManagedDatabaseConnection](api.md#manageddatabaseconnection)
-- [Middleware](api.md#middleware)
-- [MissingConfigError](api.md#missingconfigerror)
-- [MissingParameterError](api.md#missingparametererror)
-- [MySQLConnection](api.md#mysqlconnection)
-- [MySQLDatabase](api.md#mysqldatabase)
-- [Query](api.md#query)
-- [RawQuery](api.md#rawquery)
-- [Request](api.md#request)
-- [Response](api.md#response)
-- [ResponseData](api.md#responsedata)
-- [ServiceProvider](api.md#serviceprovider)
-- [ServiceResponse](api.md#serviceresponse)
-- [StatusCode](api.md#statuscode)
-- [StormError](api.md#stormerror)
-- [TemporaryTableQuery](api.md#temporarytablequery)
-- [Token](api.md#token)
-- [TokenManager](api.md#tokenmanager)
-- [UnauthorizedAccessError](api.md#unauthorizedaccesserror)
-- [getInstance](api.md#getinstance)
-
-### Namespaces
-
-- [formidable](api.formidable.md)
-
-### Variables
-
-- [formidable](api.md#formidable)
-
-## References
-
-### Application
-
-Re-exports: [Application](../classes/Application.Application-1.md)
-
-___
-
-### BackendAuthenticationMiddleware
-
-Re-exports: [BackendAuthenticationMiddleware](../classes/BackendAuthenticationMiddleware.BackendAuthenticationMiddleware-1.md)
-
-___
-
-### CORSMiddleware
-
-Re-exports: [CORSMiddleware](../classes/CORSMiddleware.CORSMiddleware-1.md)
-
-___
-
-### ConfigLoader
-
-Re-exports: [ConfigLoader](../classes/ConfigLoader.ConfigLoader-1.md)
-
-___
-
-### Database
-
-Re-exports: [Database](../classes/Database.Database-1.md)
-
-___
-
-### DatabaseConnection
-
-Re-exports: [DatabaseConnection](../classes/DatabaseConnection.DatabaseConnection-1.md)
-
-___
-
-### DatabaseQueryError
-
-Re-exports: [DatabaseQueryError](../classes/DatabaseQueryError.DatabaseQueryError-1.md)
-
-___
-
-### DiskSpaceError
-
-Re-exports: [DiskSpaceError](../classes/DiskSpaceError.DiskSpaceError-1.md)
-
-___
-
-### DropTemporaryTableQuery
-
-Re-exports: [DropTemporaryTableQuery](../classes/DropTemporaryTableQuery.DropTemporaryTableQuery-1.md)
-
-___
-
-### DumpStream
-
-Re-exports: [DumpStream](../classes/DumpStream.DumpStream-1.md)
-
-___
-
-### DuplicateEntryError
-
-Re-exports: [DuplicateEntryError](../classes/DuplicateEntryError.DuplicateEntryError-1.md)
-
-___
-
-### EntityNotFoundError
-
-Re-exports: [EntityNotFoundError](../classes/EntityNotFoundError.EntityNotFoundError-1.md)
-
-___
-
-### ErrorCode
-
-Re-exports: [ErrorCode](../enums/ErrorCode.ErrorCode-1.md)
-
-___
-
-### ExitCode
-
-Re-exports: [ExitCode](../enums/ExitCode.ExitCode-1.md)
-
-___
-
-### ExpiredTokenError
-
-Re-exports: [ExpiredTokenError](../classes/ExpiredTokenError.ExpiredTokenError-1.md)
-
-___
-
-### HTTPMethod
-
-Re-exports: [HTTPMethod](../enums/HTTPMethod.HTTPMethod-1.md)
-
-___
-
-### Handler
-
-Re-exports: [Handler](../classes/Handler.Handler-1.md)
-
-___
-
-### IAdditionalErrorDetails
-
-Re-exports: [IAdditionalErrorDetails](../interfaces/StormError.IAdditionalErrorDetails.md)
-
-___
-
-### IAuthTokenData
-
-Re-exports: [IAuthTokenData](../interfaces/IAuthTokenData.IAuthTokenData-1.md)
-
-___
-
-### IConfig
-
-Re-exports: [IConfig](../interfaces/IConfig.IConfig-1.md)
-
-___
-
-### IDatabaseConfig
-
-Re-exports: [IDatabaseConfig](../interfaces/IDatabaseConfig.IDatabaseConfig-1.md)
-
-___
-
-### IDatabaseConnection
-
-Re-exports: [IDatabaseConnection](../interfaces/IDatabaseConnection.IDatabaseConnection-1.md)
-
-___
-
-### IDeleteQueryResult
-
-Re-exports: [IDeleteQueryResult](IDeleteQueryResult.md#ideletequeryresult)
-
-___
-
-### IErrorResponse
-
-Re-exports: [IErrorResponse](../interfaces/StormError.IErrorResponse.md)
-
-___
-
-### IFormData
-
-Re-exports: [IFormData](../interfaces/IFormData.IFormData-1.md)
-
-___
-
-### IHandler
-
-Re-exports: [IHandler](../interfaces/IHandler.IHandler-1.md)
-
-___
-
-### IHandlerError
-
-Re-exports: [IHandlerError](Handler.md#ihandlererror)
-
-___
-
-### IHandlerResponse
-
-Re-exports: [IHandlerResponse](Handler.md#ihandlerresponse)
-
-___
-
-### IInsertQueryResult
-
-Re-exports: [IInsertQueryResult](../interfaces/IInsertQueryResult.IInsertQueryResult-1.md)
-
-___
-
-### IJWTVerifyOptions
-
-Re-exports: [IJWTVerifyOptions](../interfaces/IJWTVerifyOptions.IJWTVerifyOptions-1.md)
-
-___
-
-### IParameterMap
-
-Re-exports: [IParameterMap](../interfaces/Request.IParameterMap.md)
-
-___
-
-### IRequestResponse
-
-Re-exports: [IRequestResponse](../interfaces/IRequestResponse.IRequestResponse-1.md)
-
-___
-
-### IServiceHeaders
-
-Re-exports: [IServiceHeaders](../interfaces/IServiceHeaders.IServiceHeaders-1.md)
-
-___
-
-### ITemporaryTableQueryInput
-
-Re-exports: [ITemporaryTableQueryInput](../interfaces/TemporaryTableQuery.ITemporaryTableQueryInput.md)
-
-___
-
-### IUpdateQueryResult
-
-Re-exports: [IUpdateQueryResult](../interfaces/IUpdateQueryResult.IUpdateQueryResult-1.md)
-
-___
-
-### InternalError
-
-Re-exports: [InternalError](../classes/InternalError.InternalError-1.md)
-
-___
-
-### InvalidCredentialsError
-
-Re-exports: [InvalidCredentialsError](../classes/InvalidCredentialsError.InvalidCredentialsError-1.md)
-
-___
-
-### InvalidValueError
-
-Re-exports: [InvalidValueError](../classes/InvalidValueError.InvalidValueError-1.md)
-
-___
-
-### JWTError
-
-Re-exports: [JWTError](../enums/JWTError.JWTError-1.md)
-
-___
-
-### ManagedDatabaseConnection
-
-Re-exports: [ManagedDatabaseConnection](../classes/ManagedDatabaseConnection.ManagedDatabaseConnection-1.md)
-
-___
-
-### Middleware
-
-Re-exports: [Middleware](../classes/Middleware.Middleware-1.md)
-
-___
-
-### MissingConfigError
-
-Re-exports: [MissingConfigError](../classes/MissingConfigError.MissingConfigError-1.md)
-
-___
-
-### MissingParameterError
-
-Re-exports: [MissingParameterError](../classes/MissingParameterError.MissingParameterError-1.md)
-
-___
-
-### MySQLConnection
-
-Re-exports: [MySQLConnection](../classes/MySQLConnection.MySQLConnection-1.md)
-
-___
-
-### MySQLDatabase
-
-Re-exports: [MySQLDatabase](../classes/MySQLDatabase.MySQLDatabase-1.md)
-
-___
-
-### Query
-
-Re-exports: [Query](../classes/Query.Query-1.md)
-
-___
-
-### RawQuery
-
-Re-exports: [RawQuery](../classes/RawQuery.RawQuery-1.md)
-
-___
-
-### Request
-
-Re-exports: [Request](../classes/Request.Request-1.md)
-
-___
-
-### Response
-
-Re-exports: [Response](../classes/Response.Response-1.md)
-
-___
-
-### ResponseData
-
-Re-exports: [ResponseData](../classes/ResponseData.ResponseData-1.md)
-
-___
-
-### ServiceProvider
-
-Re-exports: [ServiceProvider](../classes/ServiceProvider.ServiceProvider-1.md)
-
-___
-
-### ServiceResponse
-
-Re-exports: [ServiceResponse](../classes/ServiceResponse.ServiceResponse-1.md)
-
-___
-
-### StatusCode
-
-Re-exports: [StatusCode](../enums/StatusCode.StatusCode-1.md)
-
-___
-
-### StormError
-
-Re-exports: [StormError](../classes/StormError.StormError-1.md)
-
-___
-
-### TemporaryTableQuery
-
-Re-exports: [TemporaryTableQuery](../classes/TemporaryTableQuery.TemporaryTableQuery-1.md)
-
-___
-
-### Token
-
-Re-exports: [Token](../classes/Token.Token-1.md)
-
-___
-
-### TokenManager
-
-Re-exports: [TokenManager](../classes/TokenManager.TokenManager-1.md)
-
-___
-
-### UnauthorizedAccessError
-
-Re-exports: [UnauthorizedAccessError](../classes/UnauthorizedAccessError.UnauthorizedAccessError-1.md)
-
-___
-
-### getInstance
-
-Re-exports: [getInstance](instance.md#getinstance)
-
-## Variables
-
-### formidable
-
-• **formidable**: (`options?`: [`Options`](../interfaces/api.formidable.Options.md)) => `IncomingForm` & [`MappedParsers`](api.formidable.md#mappedparsers)
-
-#### Defined in
-
-node_modules/@types/formidable/index.d.ts:281

package/docs/modules/instance.md

@@ -1,44 +0,0 @@
-[@breautek/storm](../README.md) / instance
-
-# Module: instance
-
-## Table of contents
-
-### Functions
-
-- [getInstance](instance.md#getinstance)
-- [setInstance](instance.md#setinstance)
-
-## Functions
-
-### getInstance
-
-▸ `Let` **getInstance**(): [`Application`](../classes/Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>
-
-#### Returns
-
-[`Application`](../classes/Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>
-
-#### Defined in
-
-[src/instance.ts:28](https://github.com/breautek/storm/blob/8c3a317/src/instance.ts#L28)
-
-___
-
-### setInstance
-
-▸ `Let` **setInstance**(`app`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `app` | [`Application`](../classes/Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\> |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[src/instance.ts:21](https://github.com/breautek/storm/blob/8c3a317/src/instance.ts#L21)

package/docs/modules/private_CommitQuery.md

@@ -1,9 +0,0 @@
-[@breautek/storm](../README.md) / private/CommitQuery
-
-# Module: private/CommitQuery
-
-## Table of contents
-
-### Classes
-
-- [CommitQuery](../classes/private_CommitQuery.CommitQuery.md)

package/docs/modules/private_RollbackQuery.md

@@ -1,9 +0,0 @@
-[@breautek/storm](../README.md) / private/RollbackQuery
-
-# Module: private/RollbackQuery
-
-## Table of contents
-
-### Classes
-
-- [RollbackQuery](../classes/private_RollbackQuery.RollbackQuery.md)

package/docs/modules/private_StartTransactionQuery.md

@@ -1,9 +0,0 @@
-[@breautek/storm](../README.md) / private/StartTransactionQuery
-
-# Module: private/StartTransactionQuery
-
-## Table of contents
-
-### Classes
-
-- [StartTransactionQuery](../classes/private_StartTransactionQuery.StartTransactionQuery.md)