@breautek/storm 3.3.1 → 4.1.0

package/docs/classes/ServiceProvider.ServiceProvider-1.md

@@ -1,298 +0,0 @@
-[@breautek/storm](../README.md) / [ServiceProvider](../modules/ServiceProvider.md) / ServiceProvider
-
-# Class: ServiceProvider
-
-[ServiceProvider](../modules/ServiceProvider.md).ServiceProvider
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ServiceProvider.ServiceProvider-1.md#constructor)
-
-### Methods
-
-- [\_createURL](ServiceProvider.ServiceProvider-1.md#_createurl)
-- [\_getApp](ServiceProvider.ServiceProvider-1.md#_getapp)
-- [\_getBase](ServiceProvider.ServiceProvider-1.md#_getbase)
-- [\_getDomain](ServiceProvider.ServiceProvider-1.md#_getdomain)
-- [\_getPort](ServiceProvider.ServiceProvider-1.md#_getport)
-- [\_getProtocol](ServiceProvider.ServiceProvider-1.md#_getprotocol)
-- [delete](ServiceProvider.ServiceProvider-1.md#delete)
-- [get](ServiceProvider.ServiceProvider-1.md#get)
-- [getApp](ServiceProvider.ServiceProvider-1.md#getapp)
-- [getVersion](ServiceProvider.ServiceProvider-1.md#getversion)
-- [post](ServiceProvider.ServiceProvider-1.md#post)
-- [put](ServiceProvider.ServiceProvider-1.md#put)
-- [request](ServiceProvider.ServiceProvider-1.md#request)
-- [urlSuffix](ServiceProvider.ServiceProvider-1.md#urlsuffix)
-
-## Constructors
-
-### constructor
-
-• **new ServiceProvider**(`app`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `app` | [`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\> |
-
-#### Defined in
-
-[src/ServiceProvider.ts:30](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L30)
-
-## Methods
-
-### \_createURL
-
-▸ `Protected` **_createURL**(`url`, `queryParams?`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `queryParams?` | `IDictionary`<`any`\> |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:65](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L65)
-
-___
-
-### \_getApp
-
-▸ `Protected` **_getApp**(): [`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>
-
-#### Returns
-
-[`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:37](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L37)
-
-___
-
-### \_getBase
-
-▸ `Protected` `Abstract` **_getBase**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:34](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L34)
-
-___
-
-### \_getDomain
-
-▸ `Protected` **_getDomain**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:45](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L45)
-
-___
-
-### \_getPort
-
-▸ `Protected` `Abstract` **_getPort**(): `number`
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/ServiceProvider.ts:35](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L35)
-
-___
-
-### \_getProtocol
-
-▸ `Protected` **_getProtocol**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:57](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L57)
-
-___
-
-### delete
-
-▸ **delete**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.IServiceHeaders-1.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:158](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L158)
-
-___
-
-### get
-
-▸ **get**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.IServiceHeaders-1.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:143](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L143)
-
-___
-
-### getApp
-
-▸ **getApp**(): [`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>
-
-#### Returns
-
-[`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:41](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L41)
-
-___
-
-### getVersion
-
-▸ **getVersion**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:61](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L61)
-
-___
-
-### post
-
-▸ **post**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.IServiceHeaders-1.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:148](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L148)
-
-___
-
-### put
-
-▸ **put**(`url`, `accessToken`, `data?`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data?` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.IServiceHeaders-1.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:153](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L153)
-
-___
-
-### request
-
-▸ **request**(`method`, `url`, `accessToken`, `data`, `headers?`, `additionalOptions?`): `Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `method` | [`HTTPMethod`](../enums/HTTPMethod.HTTPMethod-1.md) |
-| `url` | `string` |
-| `accessToken` | `string` |
-| `data` | `any` |
-| `headers?` | [`IServiceHeaders`](../interfaces/IServiceHeaders.IServiceHeaders-1.md) |
-| `additionalOptions?` | `any` |
-
-#### Returns
-
-`Promise`<[`ServiceResponse`](ServiceResponse.ServiceResponse-1.md)\>
-
-#### Defined in
-
-[src/ServiceProvider.ts:83](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L83)
-
-___
-
-### urlSuffix
-
-▸ **urlSuffix**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/ServiceProvider.ts:53](https://github.com/breautek/storm/blob/8c3a317/src/ServiceProvider.ts#L53)

package/docs/classes/StormError.StormError-1.md

@@ -1,309 +0,0 @@
-[@breautek/storm](../README.md) / [StormError](../modules/StormError.md) / StormError
-
-# Class: StormError<TErrorDetails\>
-
-[StormError](../modules/StormError.md).StormError
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TErrorDetails` | `any` |
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`StormError`**
-
-  ↳↳ [`DatabaseQueryError`](DatabaseQueryError.DatabaseQueryError-1.md)
-
-  ↳↳ [`DiskSpaceError`](DiskSpaceError.DiskSpaceError-1.md)
-
-  ↳↳ [`DuplicateEntryError`](DuplicateEntryError.DuplicateEntryError-1.md)
-
-  ↳↳ [`EntityNotFoundError`](EntityNotFoundError.EntityNotFoundError-1.md)
-
-  ↳↳ [`ExpiredTokenError`](ExpiredTokenError.ExpiredTokenError-1.md)
-
-  ↳↳ [`InternalError`](InternalError.InternalError-1.md)
-
-  ↳↳ [`InvalidConfigError`](InvalidConfigError.InvalidConfigError-1.md)
-
-  ↳↳ [`InvalidCredentialsError`](InvalidCredentialsError.InvalidCredentialsError-1.md)
-
-  ↳↳ [`InvalidValueError`](InvalidValueError.InvalidValueError-1.md)
-
-  ↳↳ [`MissingConfigError`](MissingConfigError.MissingConfigError-1.md)
-
-  ↳↳ [`MissingParameterError`](MissingParameterError.MissingParameterError-1.md)
-
-  ↳↳ [`UnauthorizedAccessError`](UnauthorizedAccessError.UnauthorizedAccessError-1.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](StormError.StormError-1.md#constructor)
-
-### Properties
-
-- [message](StormError.StormError-1.md#message)
-- [name](StormError.StormError-1.md#name)
-- [stack](StormError.StormError-1.md#stack)
-- [prepareStackTrace](StormError.StormError-1.md#preparestacktrace)
-- [stackTraceLimit](StormError.StormError-1.md#stacktracelimit)
-
-### Methods
-
-- [getCode](StormError.StormError-1.md#getcode)
-- [getErrorResponse](StormError.StormError-1.md#geterrorresponse)
-- [getExitCode](StormError.StormError-1.md#getexitcode)
-- [getHTTPCode](StormError.StormError-1.md#gethttpcode)
-- [getMessage](StormError.StormError-1.md#getmessage)
-- [getPrivateDetails](StormError.StormError-1.md#getprivatedetails)
-- [getPublicDetails](StormError.StormError-1.md#getpublicdetails)
-- [captureStackTrace](StormError.StormError-1.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new StormError**<`TErrorDetails`\>(`details?`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TErrorDetails` | `any` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `details?` | `TErrorDetails` |
-
-#### Overrides
-
-Error.constructor
-
-#### Defined in
-
-[src/StormError.ts:38](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L38)
-
-## Properties
-
-### message
-
-• **message**: `string`
-
-#### Inherited from
-
-Error.message
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:974
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-Error.name
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:973
-
-___
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-Error.stack
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:975
-
-___
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-Optional override for formatting stack traces
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-#### Inherited from
-
-Error.prepareStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:11
-
-___
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:13
-
-## Methods
-
-### getCode
-
-▸ `Abstract` **getCode**(): `number`
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/StormError.ts:49](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L49)
-
-___
-
-### getErrorResponse
-
-▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/StormError.IErrorResponse.md)
-
-#### Returns
-
-[`IErrorResponse`](../interfaces/StormError.IErrorResponse.md)
-
-#### Defined in
-
-[src/StormError.ts:70](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L70)
-
-___
-
-### getExitCode
-
-▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.ExitCode-1.md)
-
-#### Returns
-
-[`ExitCode`](../enums/ExitCode.ExitCode-1.md)
-
-#### Defined in
-
-[src/StormError.ts:79](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L79)
-
-___
-
-### getHTTPCode
-
-▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.StatusCode-1.md)
-
-#### Returns
-
-[`StatusCode`](../enums/StatusCode.StatusCode-1.md)
-
-#### Defined in
-
-[src/StormError.ts:66](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L66)
-
-___
-
-### getMessage
-
-▸ `Abstract` **getMessage**(): `string`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/StormError.ts:48](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L48)
-
-___
-
-### getPrivateDetails
-
-▸ **getPrivateDetails**(): `TErrorDetails`
-
-Private details are only logged to the server log.
-They are kept secret from the client.
-
-#### Returns
-
-`TErrorDetails`
-
-#### Defined in
-
-[src/StormError.ts:62](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L62)
-
-___
-
-### getPublicDetails
-
-▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/StormError.IAdditionalErrorDetails.md)
-
-Sends details to the client.
-
-#### Returns
-
-[`IAdditionalErrorDetails`](../interfaces/StormError.IAdditionalErrorDetails.md)
-
-#### Defined in
-
-[src/StormError.ts:54](https://github.com/breautek/storm/blob/8c3a317/src/StormError.ts#L54)
-
-___
-
-### captureStackTrace
-
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Error.captureStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:4