Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

AuthorizeFailedHandler

AuthorizeFailedHandler<TRequest>: (context: AuthorizeFailedHandlerContext<TRequest>) => any

A handler, that is invoked, if authorization failed.

param

The context.

Type parameters

  • TRequest: express.Request = express.Request

Type declaration

AuthorizeHandler

AuthorizeHandler<TRequest>: (context: AuthorizeHandlerContext<TRequest>) => AuthorizeHandlerResult | PromiseLike<AuthorizeHandlerResult>

An authorization handler.

param

The context.

returns

The result.

Type parameters

  • TRequest: express.Request = express.Request

Type declaration

AuthorizeHandlerResult

AuthorizeHandlerResult: boolean | void | null | undefined | string

The result of an authorization handler.

Variables

Const AUTHORIZER_OPTIONS

AUTHORIZER_OPTIONS: typeof AUTHORIZER_OPTIONS = ...

Key for storing Authorize() options.

Functions

Authorize

createRouteAuthorizer

  • createRouteAuthorizer(controller: Controller, method: Function): express.RequestHandler
  • Creates a middleware for handling an 'Authorize()' decorator, if defined.

    Parameters

    • controller: Controller

      The controller.

    • method: Function

      The underlying router method.

    Returns express.RequestHandler

    The created middle.

getAuthorizeFailedHandler

getAuthorizeHandler

setAuthorizeFailedHandler

  • Sets the global handler, which is invoked if a request authorization fails.

    Parameters

    Returns void

setAuthorizeHandler

  • Sets the global handler, which authorizes requests.

    Parameters

    Returns void

Generated using TypeDoc