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

Type Parameters

TApplication extends Application = Application
TGetRequest = any
TGetResponse = IHandlerResponse
TPostRequest = any
TPostResponse = IHandlerResponse
TPutRequest = any
TPutResponse = IHandlerResponse
TDeleteRequest = any
TDeleteResponse = IHandlerResponse

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 = any,
    TGetResponse = any,
    TPostRequest = any,
    TPostResponse = any,
    TPutRequest = any,
    TPutResponse = any,
    TDeleteRequest = any,
    TDeleteResponse = any,
>(
    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 = any
- TGetResponse = any
- TPostRequest = any
- TPostResponse = any
- TPutRequest = any
- TPutResponse = any
- TDeleteRequest = any
- TDeleteResponse = any
Parameters
- app: TApplication
Returns Handler<
    TApplication,
    TGetRequest,
    TGetResponse,
    TPostRequest,
    TPostResponse,
    TPutRequest,
    TPutResponse,
    TDeleteRequest,
    TDeleteResponse,
>
- Defined in src/Handler.ts:71

Methods

`Protected`_delete

_delete(request: Request<TDeleteRequest>): Promise<TDeleteResponse>
Parameters
- request: Request<TDeleteRequest>
Returns Promise<TDeleteResponse>
- Defined in src/Handler.ts:210

`Protected`_get

_get(request: Request<TGetRequest>): Promise<TGetResponse>
Parameters
- request: Request<TGetRequest>
Returns Promise<TGetResponse>
- Defined in src/Handler.ts:198

`Protected`_initMiddlewares

_initMiddlewares(): Middleware[]
Returns Middleware[]
- Defined in src/Handler.ts:80

`Protected`_onMiddlewareReject

_onMiddlewareReject(
    request: Request,
    response: Response,
    error: StormError,
): void
Parameters
- request: Request
- response: Response
- error: StormError
Returns void
- Defined in src/Handler.ts:136

`Protected`_post

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

`Protected`_put

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

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:185

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:146

getAccessToken

getAccessToken(request: Request): string
Parameters
- request: Request
Returns string
- Defined in src/Handler.ts:84

getApplication

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

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:172

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:159

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>

Protected_get

Parameters

Returns Promise<TGetResponse>

Protected_initMiddlewares

Returns Middleware[]

Protected_onMiddlewareReject

Parameters

Returns void

Protected_post

Parameters

Returns Promise<TPostResponse>

Protected_put

Parameters

Returns Promise<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

`Protected`_onMiddlewareReject

`Protected`_post

`Protected`_put