Class OAuth2PasswordTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>

Type Parameters

P = core.ParamsDictionary
ResBody = any
ReqBody = any
ReqQuery = ParsedQs
Locals extends Record<string, any> = Record<string, any>
MetaResType = any

Implements

IOAuth2Route

Index

Constructors

constructor

new OAuth2PasswordTokenRoute<
    P = ParamsDictionary,
    ResBody = any,
    ReqBody = any,
    ReqQuery = ParsedQs,
    Locals extends Record<string, any> = Record<string, any>,
    MetaResType = any,
>(
    url: string,
    handler?: OAuth2PasswordTokenHandler<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >,
): OAuth2PasswordTokenRoute<
    P,
    ResBody,
    ReqBody,
    ReqQuery,
    Locals,
    MetaResType,
>
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- url: string
- Optionalhandler: OAuth2PasswordTokenHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
Returns OAuth2PasswordTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
- Defined in src/security/oauth2/password.ts:57

Properties

`Protected` `Optional`badRequestHandler

badRequestHandler?: OAuth2BadRequestHandler<
    P,
    ResBody,
    ReqBody,
    ReqQuery,
    Locals,
    MetaResType,
>

`Protected` `Optional`handler

handler?: OAuth2PasswordTokenHandler<
    P,
    ResBody,
    ReqBody,
    ReqQuery,
    Locals,
    MetaResType,
>

`Protected`url

url: string

Methods

getBadRequestHandler

getBadRequestHandler(): | OAuth2BadRequestHandler<
    P,
    ResBody,
    ReqBody,
    ReqQuery,
    Locals,
    MetaResType,
>
| undefined
Returns
    | OAuth2BadRequestHandler<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >
    | undefined
Implementation of IOAuth2Route.getBadRequestHandler
- Defined in src/security/oauth2/password.ts:85

getHandler

getHandler(): | OAuth2PasswordTokenHandler<
    P,
    ResBody,
    ReqBody,
    ReqQuery,
    Locals,
    MetaResType,
>
| undefined
Returns
    | OAuth2PasswordTokenHandler<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >
    | undefined
Implementation of IOAuth2Route.getHandler
- Defined in src/security/oauth2/password.ts:71

getUrl

getUrl(): string
Returns string
Implementation of IOAuth2Route.getUrl
- Defined in src/security/oauth2/password.ts:62

resetBadRequestHandler

resetBadRequestHandler(): this
Returns this
- Defined in src/security/oauth2/password.ts:80

setBadRequestHandler

setBadRequestHandler(
    handler?: OAuth2BadRequestHandler<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >,
): this
Parameters
- Optionalhandler: OAuth2BadRequestHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
Returns this
- Defined in src/security/oauth2/password.ts:75

setHandler

setHandler(
    handler?: OAuth2PasswordTokenHandler<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >,
): this
Parameters
- Optionalhandler: OAuth2PasswordTokenHandler<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
Returns this
- Defined in src/security/oauth2/password.ts:66

Class OAuth2PasswordTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OAuth2PasswordTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>

Properties

`Protected` `Optional`badRequestHandler

`Protected` `Optional`handler

`Protected`url

Methods

getBadRequestHandler

Returns
    | OAuth2BadRequestHandler<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >
    | undefined

getHandler

Returns
    | OAuth2PasswordTokenHandler<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >
    | undefined

getUrl

Returns string

resetBadRequestHandler

Returns this

setBadRequestHandler

Parameters

Returns this

setHandler

Parameters

Returns this

Settings

On This Page

Class OAuth2PasswordTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OAuth2PasswordTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>

Properties

Protected OptionalbadRequestHandler

Protected Optionalhandler

Protectedurl

Methods

getBadRequestHandler

Returns | OAuth2BadRequestHandler< P, ResBody, ReqBody, ReqQuery, Locals, MetaResType, > | undefined

getHandler

Returns | OAuth2PasswordTokenHandler< P, ResBody, ReqBody, ReqQuery, Locals, MetaResType, > | undefined

getUrl

Returns string

resetBadRequestHandler

Returns this

setBadRequestHandler

Parameters

Returns this

setHandler

Parameters

Returns this

Settings

On This Page

`Protected` `Optional`badRequestHandler

`Protected` `Optional`handler

`Protected`url

Returns
| OAuth2BadRequestHandler<
P,
ResBody,
ReqBody,
ReqQuery,
Locals,
MetaResType,
>
| undefined

Returns
| OAuth2PasswordTokenHandler<
P,
ResBody,
ReqBody,
ReqQuery,
Locals,
MetaResType,
>
| undefined