Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Controller<TApp>

Describes a controller.

Type parameters

Hierarchy

  • Controller

Implemented by

Index

Properties

Readonly __app

__app: TApp

The underlying app instance.

Optional Readonly __authorize

__authorize: AuthorizeHandler<Request>

The controller-wide authorization handler.

Optional Readonly __authorizeFailed

__authorizeFailed: AuthorizeFailedHandler<Request>

The controller-wide "authorization failed handler".

Readonly __dbg

__dbg: (message?: any, tag?: string) => void

Writes a debug message.

param

The message to write.

param

The optional tag.

Type declaration

    • (message?: any, tag?: string): void
    • Parameters

      • Optional message: any
      • Optional tag: string

      Returns void

Optional __error

__error: RequestErrorHandler<Request>

An optional, custom handler for errors.

Readonly __file

__file: string

The path to the underlying module file.

Optional __init

__init: () => void

Initializes the controller.

Type declaration

    • (): void
    • Returns void

Readonly __rootPath

__rootPath: string

The root path.

Readonly __router

__router: Router

The Express router.

Optional __serialize

__serialize: ResponseSerializer<Request>

An optional, custom handler for serializing the response.

Optional __updateSwaggerPath

__updateSwaggerPath: SwaggerPathDefinitionUpdater

Controller wide method to update a Swagger path definition.

Optional __use

__use: RequestHandler | RequestHandler[]

One or more optional request handlers, wich are used as prefixed middleware(s).

Optional __useAfter

__useAfter: AfterRequestHandler<Request>

Controller wide "after-ware".

Generated using TypeDoc