Class WebRouter<APP_STATE, ROUTER_STATE>`Abstract`

Public interface for a Swizzy web router.

Type Parameters

APP_STATE
ROUTER_STATE

Implements

IWebRouter<APP_STATE, ROUTER_STATE>

Index

Constructors

Properties

actualRouter? logger middleware name path state? webControllerClasses isWebRouter

Methods

getInitializedRouter getMiddleware getState initialize installMiddleware isInitialized router toJson toString uninstall

Constructors

constructor

new WebRouter<APP_STATE, ROUTER_STATE>(
props: IInternalWebRouterProps<APP_STATE, ROUTER_STATE>,
): WebRouter<APP_STATE, ROUTER_STATE>
Type Parameters
- APP_STATE
- ROUTER_STATE
Parameters
- props: IInternalWebRouterProps<APP_STATE, ROUTER_STATE>
Returns WebRouter<APP_STATE, ROUTER_STATE>
- Defined in src/router/web-router.ts:184

Properties

`Optional`actualRouter

actualRouter?: IRouter

Actual express router initialized in initialize method

`Protected`logger

logger: ILogger<any>

logger

`Protected` `Readonly`middleware

middleware: SwizzyMiddleware<ROUTER_STATE>[]

Router middleware

`Readonly`name

name: string

Web router name

`Readonly`path

path: string

URL path prefix for all controllers mounted on this router.

`Optional`state

state?: ROUTER_STATE

`Protected` `Readonly`webControllerClasses

webControllerClasses: NewWebControllerClass<ROUTER_STATE, any>[]

Controller classes to be attached to this router

`Static`isWebRouter

isWebRouter: boolean = true

Flag for if this is a webrouter, alwaus true for all web routers

Methods

`Protected`getInitializedRouter

getInitializedRouter(props: IWebRouterInitProps<APP_STATE>): Promise<IRouter>
overide this to configure your router, ensuring you call super first.
Parameters
- props: IWebRouterInitProps<APP_STATE>
Returns Promise<IRouter>
- Defined in src/router/web-router.ts:252

`Protected`getMiddleware

getMiddleware(): SwizzyMiddleware<ROUTER_STATE>[]
Returns the middleware list configured for this router. Override to provide a dynamic middleware list.

Returns SwizzyMiddleware<ROUTER_STATE>[]
array of swizzy middleware factories
- Defined in src/router/web-router.ts:402

getState

getState(): ROUTER_STATE
Returns the current router-level state.

Returns ROUTER_STATE
the router state, or an empty object if not yet initialized
Implementation of IWebRouter.getState
- Defined in src/router/web-router.ts:375

initialize

initialize(props: IWebRouterInitProps<APP_STATE>): Promise<void>
Initializes router, needs to be called before calling router() method.
Parameters
- props: IWebRouterInitProps<APP_STATE>
Returns Promise<void>
Implementation of IWebRouter.initialize
- Defined in src/router/web-router.ts:198

`Protected`installMiddleware

installMiddleware(props: IInstallRouterMiddlewareProps): Promise<void>
Parameters
- props: IInstallRouterMiddlewareProps
Returns Promise<void>
- Defined in src/router/web-router.ts:379

isInitialized

isInitialized(): boolean
Returns true if the router has already been initialized.

Returns boolean
- Defined in src/router/web-router.ts:234

router

router(): IRouter
Returns the underlying Express router.

Returns IRouter
Throws
if initialize has not been called yet
Implementation of IWebRouter.router
- Defined in src/router/web-router.ts:360

toJson

toJson(): {
    installedControllers: any[];
    logger: undefined;
    middleware: any[];
    name: string;
    path: string;
    stateConverter: { name: string };
    webControllerClasses: NewWebControllerClass<ROUTER_STATE, any>[];
}
Serializes the router to a plain JSON-compatible object.

Returns {
    installedControllers: any[];
    logger: undefined;
    middleware: any[];
    name: string;
    path: string;
    stateConverter: { name: string };
    webControllerClasses: NewWebControllerClass<ROUTER_STATE, any>[];
}
JSON representation of this router
Implementation of IWebRouter.toJson
- Defined in src/router/web-router.ts:410

toString

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

Returns string
stringified JSON of the router
Implementation of IWebRouter.toString
- Defined in src/router/web-router.ts:431

uninstall

uninstall(props: UninstallRouterProps): void
Removes this router and all of its controllers/middleware from the app.
Parameters
- props: UninstallRouterProps
  contains the Express app instance
Returns void
Implementation of IWebRouter.uninstall
- Defined in src/router/web-router.ts:305