Class Handler<TApplication, TGetRequest, TGetResponse, TPostRequest, TPostResponse, TPutRequest, TPutResponse, TDeleteRequest, TDeleteResponse>

Type Parameters

TApplication extends Application = Application
TGetRequest = void
TGetResponse extends TSupportedResponseTypes = TSupportedResponseTypes
TPostRequest = void
TPostResponse extends TSupportedResponseTypes = TSupportedResponseTypes
TPutRequest = void
TPutResponse extends TSupportedResponseTypes = TSupportedResponseTypes
TDeleteRequest = void
TDeleteResponse extends TSupportedResponseTypes = TSupportedResponseTypes

Index

Constructors

constructor

Methods

_delete _get _initMiddlewares _onMiddlewareReject _post _put delete get getAccessToken getApplication post put

Constructors

constructor

new Handler<
    TApplication extends
        Application<IConfig, IAuthTokenData, any, any> = Application<
        IConfig,
        IAuthTokenData,
        any,
        any,
    >,
    TGetRequest = void,
    TGetResponse extends TSupportedResponseTypes = TSupportedResponseTypes,
    TPostRequest = void,
    TPostResponse extends TSupportedResponseTypes = TSupportedResponseTypes,
    TPutRequest = void,
    TPutResponse extends TSupportedResponseTypes = TSupportedResponseTypes,
    TDeleteRequest = void,
    TDeleteResponse extends TSupportedResponseTypes = TSupportedResponseTypes,
>(
    app: TApplication,
): Handler<
    TApplication,
    TGetRequest,
    TGetResponse,
    TPostRequest,
    TPostResponse,
    TPutRequest,
    TPutResponse,
    TDeleteRequest,
    TDeleteResponse,
>
Type Parameters
- TApplication extends Application<IConfig, IAuthTokenData, any, any> = Application<IConfig, IAuthTokenData, any, any>
- TGetRequest = void
- TGetResponse extends TSupportedResponseTypes = TSupportedResponseTypes
- TPostRequest = void
- TPostResponse extends TSupportedResponseTypes = TSupportedResponseTypes
- TPutRequest = void
- TPutResponse extends TSupportedResponseTypes = TSupportedResponseTypes
- TDeleteRequest = void
- TDeleteResponse extends TSupportedResponseTypes = TSupportedResponseTypes
Parameters
- app: TApplication
Returns Handler<
    TApplication,
    TGetRequest,
    TGetResponse,
    TPostRequest,
    TPostResponse,
    TPutRequest,
    TPutResponse,
    TDeleteRequest,
    TDeleteResponse,
>
- Defined in src/Handler.ts:51

Methods

`Protected`_onMiddlewareReject

_onMiddlewareReject(
    request: Request,
    response: Response<any>,
    error: StormError,
): void
Parameters
- request: Request
- response: Response<any>
- error: StormError
Returns void
Deprecated
- Defined in src/Handler.ts:131

`Protected`_post

_post(
request: Request<TPostRequest>,
): Promise<TPostResponse | ResponseData<TPostResponse>>
Parameters
- request: Request<TPostRequest>
Returns Promise<TPostResponse | ResponseData<TPostResponse>>
- Defined in src/Handler.ts:197

`Protected`_put

_put(
request: Request<TPutRequest>,
): Promise<TPutResponse | ResponseData<TPutResponse>>
Parameters
- request: Request<TPutRequest>
Returns Promise<TPutResponse | ResponseData<TPutResponse>>
- Defined in src/Handler.ts:201

delete

delete(
request: Request<TDeleteRequest>,
response: Response<TDeleteResponse>,
): Promise<void>
Parameters
- request: Request<TDeleteRequest>
- response: Response<TDeleteResponse>
Returns Promise<void>
- Defined in src/Handler.ts:180

get

get(
request: Request<TGetRequest>,
response: Response<TGetResponse>,
): Promise<void>
Parameters
- request: Request<TGetRequest>
- response: Response<TGetResponse>
Returns Promise<void>
- Defined in src/Handler.ts:141

getAccessToken

getAccessToken(request: Request<unknown>): string
Parameters
- request: Request<unknown>
Returns string
- Defined in src/Handler.ts:67

getApplication

getApplication(): TApplication
Returns TApplication
- Defined in src/Handler.ts:56

post

post(
request: Request<TPostRequest>,
response: Response<TPostResponse>,
): Promise<void>
Parameters
- request: Request<TPostRequest>
- response: Response<TPostResponse>
Returns Promise<void>
- Defined in src/Handler.ts:167

put

put(
request: Request<TPutRequest>,
response: Response<TPutResponse>,
): Promise<void>
Parameters
- request: Request<TPutRequest>
- response: Response<TPutResponse>
Returns Promise<void>
- Defined in src/Handler.ts:154

Class Handler<TApplication, TGetRequest, TGetResponse, TPostRequest, TPostResponse, TPutRequest, TPutResponse, TDeleteRequest, TDeleteResponse>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Handler< TApplication, TGetRequest, TGetResponse, TPostRequest, TPostResponse, TPutRequest, TPutResponse, TDeleteRequest, TDeleteResponse,>

Methods

Protected_delete

Parameters

Returns Promise<TDeleteResponse | ResponseData<TDeleteResponse>>

Protected_get

Parameters

Returns Promise<TGetResponse | ResponseData<TGetResponse>>

Protected_initMiddlewares

Returns Middleware< Application<IConfig, IAuthTokenData, any, any>, TSupportedResponseTypes,>[]

Deprecated

Protected_onMiddlewareReject

Parameters

Returns void

Deprecated

Protected_post

Parameters

Returns Promise<TPostResponse | ResponseData<TPostResponse>>

Protected_put

Parameters

Returns Promise<TPutResponse | ResponseData<TPutResponse>>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<void>

getAccessToken

Parameters

Returns string

getApplication

Returns TApplication

post

Parameters

Returns Promise<void>

put

Parameters

Returns Promise<void>

Settings

On This Page

Returns Handler<
TApplication,
TGetRequest,
TGetResponse,
TPostRequest,
TPostResponse,
TPutRequest,
TPutResponse,
TDeleteRequest,
TDeleteResponse,
>

`Protected`_delete

`Protected`_get

`Protected`_initMiddlewares

Returns Middleware<
Application<IConfig, IAuthTokenData, any, any>,
TSupportedResponseTypes,
>[]

`Protected`_onMiddlewareReject

`Protected`_post

`Protected`_put