Class WebController<ROUTER_STATE, CONTROLLER_STATE>Abstract

constructor

• new WebController<ROUTER_STATE, CONTROLLER_STATE>(
      props: IInternalWebControllerProps<ROUTER_STATE, CONTROLLER_STATE>,
  ): WebController<ROUTER_STATE, CONTROLLER_STATE>

  Constructor with internal props.

  Type Parameters

  • ROUTER_STATE
  • CONTROLLER_STATE

  Parameters

  • props: IInternalWebControllerProps<ROUTER_STATE, CONTROLLER_STATE>

  Returns WebController<ROUTER_STATE, CONTROLLER_STATE>

Readonlyaction

OptionalactualController

Readonlymethod

name

Optionalstate

Static ReadonlyisWebController

controller

• controller(): WebControllerFunction

  Returns the initialized controller function.

  Returns WebControllerFunction

  Throws

  if initialize has not been called yet

getMiddleware

• getMiddleware(): SwizzyMiddlewareFunction[]

  Returns the resolved middleware functions to be applied before this controller. Each SwizzyMiddleware factory is invoked with the current state and logger.

  Returns SwizzyMiddlewareFunction[]

  array of Express middleware functions

initialize

• initialize(props: IWebControllerInitProps<ROUTER_STATE>): Promise<void>

  Initialize controller. Must be called before calling controller()

  Parameters

  • props: IWebControllerInitProps<ROUTER_STATE>

  Returns Promise<void>

installableController

• installableController(): InstallableController<CONTROLLER_STATE>

  Returns an InstallableController descriptor used by the router to mount this controller onto an Express router.

  Returns InstallableController<CONTROLLER_STATE>

toJson

• toJson(): {
      action: string;
      logger: undefined;
      method: RequestMethod;
      middleware: any[];
      name: string;
      stateConverter: { name: string };
  }

  Serializes the controller to a plain JSON-compatible object. Logger is omitted for safety.

  Returns {
      action: string;
      logger: undefined;
      method: RequestMethod;
      middleware: any[];
      name: string;
      stateConverter: { name: string };
  }

  JSON representation of this controller

toString

• toString(): string

  Returns a JSON string representation of this controller.

  Returns string

  stringified JSON of the controller