Interface IWebController<ROUTER_STATE, CONTROLLER_STATE>

Swizzy web controller interface.

interface IWebController<ROUTER_STATE, CONTROLLER_STATE> {
    action: string;
    method: RequestMethod;
    name: string;
    controller(): WebControllerFunction;
    initialize(props: IWebControllerInitProps<ROUTER_STATE>): Promise<void>;
    installableController(): InstallableController<CONTROLLER_STATE>;
    toJson(): any;
    toString(): any;
}

Type Parameters

ROUTER_STATE
CONTROLLER_STATE

Implemented by

WebController

Index

Properties

action method name

Methods

controller initialize installableController toJson toString

Properties

action

action: string

URL segment appended to the router path for this controller, e.g. /users.

method

method: RequestMethod

HTTP method this controller responds to.

name

name: string

Display name for this controller.

Methods

controller

controller(): WebControllerFunction
Returns the initialized Express handler function.

Returns WebControllerFunction
Throws
if initialize has not been called yet
- Defined in src/controller/types.ts:52

initialize

initialize(props: IWebControllerInitProps<ROUTER_STATE>): Promise<void>
Initializes the controller with the router-level state. Must be called before controller().
Parameters
- props: IWebControllerInitProps<ROUTER_STATE>
  contains the parent router state
Returns Promise<void>
- Defined in src/controller/types.ts:47

installableController

installableController(): InstallableController<CONTROLLER_STATE>
Returns the installable descriptor used by the router to mount this controller.

Returns InstallableController<CONTROLLER_STATE>
- Defined in src/controller/types.ts:56

toJson

toJson(): any
Serializes the controller to a plain JSON-compatible object.

Returns any
- Defined in src/controller/types.ts:60

toString

toString(): any
Returns a JSON string representation of this controller.

Returns any
- Defined in src/controller/types.ts:64