Interface IAuthorizeOptions

Options for an 'authorize' decorator or prop.

interface IAuthorizeOptions {
    findAuthorizedUser?: Nilable<AuthorizedUserProvider>;
    onValidationFailed?: Nilable<AuthorizeValidationFailedHandler>;
    roles?: Nilable<AuthorizeRolesValue>;
    setupMiddleware?: Nilable<SetupAuthorizeMiddlewareHandler>;
    use?: Nilable<HttpMiddleware[]>;
    validator?: Nilable<AuthorizeValidatorValue>;
}

Index

Properties

findAuthorizedUser? onValidationFailed? roles? setupMiddleware? use? validator?

Properties

`Optional` findAuthorizedUser

findAuthorizedUser?: Nilable<AuthorizedUserProvider>

A function, which tries to find a user for the current request.

`Optional` onValidationFailed

onValidationFailed?: Nilable<AuthorizeValidationFailedHandler>

Is invoked, when validationf failes.

`Optional` roles

roles?: Nilable<AuthorizeRolesValue>

The available roles to use, or the function that provide it.

`Optional` setupMiddleware

setupMiddleware?: Nilable<SetupAuthorizeMiddlewareHandler>

A custom function to setup an 'authorize' middleware.

`Optional` use

use?: Nilable<HttpMiddleware[]>

A list of custom middlewares to add BEFORE the authorize middleware.

`Optional` validator

validator?: Nilable<AuthorizeValidatorValue>

The custom validator to use.

Generated using TypeDoc