Interface IWebRouter<APP_STATE, ROUTER_STATE>

Readonlyname

path

getState

• getState(): ROUTER_STATE

  Returns the current router-level state.

  Returns ROUTER_STATE

  the router state or an empty object if not yet initialized

initialize

• initialize(props: IWebRouterInitProps<APP_STATE>): Promise<void>

  Initializes the router, setting up controllers and middleware. Must be called before router().

  Parameters

  • props: IWebRouterInitProps<APP_STATE>

    initialization options including app state

  Returns Promise<void>

router

• router(): any

  Returns the underlying Express router. Throws if initialize has not been called.

  Returns any

toJson

• toJson(): any

  Serializes the router to a plain JSON-compatible object.

  Returns any

  JSON representation of this router

toString

• toString(): string

  Returns a JSON string representation of this router.

  Returns string

  stringified JSON of the router

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