Skip to main content

Interface: RouteOptions

@ima/core.RouteOptions

Hierarchy

Properties

autoScroll

autoScroll: boolean

Inherited from

RouteFactoryOptions.autoScroll

Defined in

packages/core/src/router/Router.ts:36


documentView

documentView: unknown

Inherited from

RouteFactoryOptions.documentView

Defined in

packages/core/src/router/Router.ts:37


extensions

Optional extensions: ("$Helper" | "$oc" | "$Settings" | "$Env" | "$Protocol" | "$Secure" | "$Request" | "$Response" | "$Window" | "$Error" | "$Dictionary" | "$CookieTransformFunction" | "$CookieStorage" | "$SessionStorage" | "$MapStorage" | "$WeakMapStorage" | "$SessionMapStorage" | "$Dispatcher" | "$EventBus" | "$CacheStorage" | "$CacheFactory" | "$Cache" | "$MetaManager" | "$ControllerDecorator" | "$PageStateManagerDecorator" | "$PageStateManager" | "$PageFactory" | "$ComponentUtils" | "$Utils" | "$PageHandlerRegistry" | "$PageManager" | "$RouteFactory" | "$Router" | "$RouteNames" | "$RouterEvents" | "$HttpUrlTransformer" | "$HttpAgentProxy" | "$Http" | "$HttpStatusCode" | "$PageRenderer" | `$Helper.${string}` | `$oc.${string}` | `$Settings.${string}` | `$Env.${string}` | `$Protocol.${string}` | `$Secure.${string}` | `$Request.${string}` | `$Response.${string}` | `$Window.${string}` | `$Error.${string}` | `$Dictionary.${string}` | `$CookieTransformFunction.${string}` | `$CookieStorage.${string}` | `$SessionStorage.${string}` | `$MapStorage.${string}` | `$WeakMapStorage.${string}` | `$SessionMapStorage.${string}` | `$Dispatcher.${string}` | `$EventBus.${string}` | `$CacheStorage.${string}` | `$CacheFactory.${string}` | `$Cache.${string}` | `$MetaManager.${string}` | `$ControllerDecorator.${string}` | `$PageStateManagerDecorator.${string}` | `$PageStateManager.${string}` | `$PageFactory.${string}` | `$ComponentUtils.${string}` | `$Utils.${string}` | `$PageHandlerRegistry.${string}` | `$PageManager.${string}` | `$RouteFactory.${string}` | `$Router.${string}` | `$RouteNames.${string}` | `$RouterEvents.${string}` | `$HttpUrlTransformer.${string}` | `$HttpAgentProxy.${string}` | `$Http.${string}` | `$HttpStatusCode.${string}` | `$PageRenderer.${string}` | "?$Helper" | "?$oc" | "?$Settings" | "?$Env" | "?$Protocol" | "?$Secure" | "?$Request" | "?$Response" | "?$Window" | "?$Error" | "?$Dictionary" | "?$CookieTransformFunction" | "?$CookieStorage" | "?$SessionStorage" | "?$MapStorage" | "?$WeakMapStorage" | "?$SessionMapStorage" | "?$Dispatcher" | "?$EventBus" | "?$CacheStorage" | "?$CacheFactory" | "?$Cache" | "?$MetaManager" | "?$ControllerDecorator" | "?$PageStateManagerDecorator" | "?$PageStateManager" | "?$PageFactory" | "?$ComponentUtils" | "?$Utils" | "?$PageHandlerRegistry" | "?$PageManager" | "?$RouteFactory" | "?$Router" | "?$RouteNames" | "?$RouterEvents" | "?$HttpUrlTransformer" | "?$HttpAgentProxy" | "?$Http" | "?$HttpStatusCode" | "?$PageRenderer" | `?$Helper.${string}` | `?$oc.${string}` | `?$Settings.${string}` | `?$Env.${string}` | `?$Protocol.${string}` | `?$Secure.${string}` | `?$Request.${string}` | `?$Response.${string}` | `?$Window.${string}` | `?$Error.${string}` | `?$Dictionary.${string}` | `?$CookieTransformFunction.${string}` | `?$CookieStorage.${string}` | `?$SessionStorage.${string}` | `?$MapStorage.${string}` | `?$WeakMapStorage.${string}` | `?$SessionMapStorage.${string}` | `?$Dispatcher.${string}` | `?$EventBus.${string}` | `?$CacheStorage.${string}` | `?$CacheFactory.${string}` | `?$Cache.${string}` | `?$MetaManager.${string}` | `?$ControllerDecorator.${string}` | `?$PageStateManagerDecorator.${string}` | `?$PageStateManager.${string}` | `?$PageFactory.${string}` | `?$ComponentUtils.${string}` | `?$Utils.${string}` | `?$PageHandlerRegistry.${string}` | `?$PageManager.${string}` | `?$RouteFactory.${string}` | `?$Router.${string}` | `?$RouteNames.${string}` | `?$RouterEvents.${string}` | `?$HttpUrlTransformer.${string}` | `?$HttpAgentProxy.${string}` | `?$Http.${string}` | `?$HttpStatusCode.${string}` | `?$PageRenderer.${string}` | "...?$Helper" | "...?$oc" | "...?$Settings" | "...?$Env" | "...?$Protocol" | "...?$Secure" | "...?$Request" | "...?$Response" | "...?$Window" | "...?$Error" | "...?$Dictionary" | "...?$CookieTransformFunction" | "...?$CookieStorage" | "...?$SessionStorage" | "...?$MapStorage" | "...?$WeakMapStorage" | "...?$SessionMapStorage" | "...?$Dispatcher" | "...?$EventBus" | "...?$CacheStorage" | "...?$CacheFactory" | "...?$Cache" | "...?$MetaManager" | "...?$ControllerDecorator" | "...?$PageStateManagerDecorator" | "...?$PageStateManager" | "...?$PageFactory" | "...?$ComponentUtils" | "...?$Utils" | "...?$PageHandlerRegistry" | "...?$PageManager" | "...?$RouteFactory" | "...?$Router" | "...?$RouteNames" | "...?$RouterEvents" | "...?$HttpUrlTransformer" | "...?$HttpAgentProxy" | "...?$Http" | "...?$HttpStatusCode" | "...?$PageRenderer" | `...?$Helper.${string}` | `...?$oc.${string}` | `...?$Settings.${string}` | `...?$Env.${string}` | `...?$Protocol.${string}` | `...?$Secure.${string}` | `...?$Request.${string}` | `...?$Response.${string}` | `...?$Window.${string}` | `...?$Error.${string}` | `...?$Dictionary.${string}` | `...?$CookieTransformFunction.${string}` | `...?$CookieStorage.${string}` | `...?$SessionStorage.${string}` | `...?$MapStorage.${string}` | `...?$WeakMapStorage.${string}` | `...?$SessionMapStorage.${string}` | `...?$Dispatcher.${string}` | `...?$EventBus.${string}` | `...?$CacheStorage.${string}` | `...?$CacheFactory.${string}` | `...?$Cache.${string}` | `...?$MetaManager.${string}` | `...?$ControllerDecorator.${string}` | `...?$PageStateManagerDecorator.${string}` | `...?$PageStateManager.${string}` | `...?$PageFactory.${string}` | `...?$ComponentUtils.${string}` | `...?$Utils.${string}` | `...?$PageHandlerRegistry.${string}` | `...?$PageManager.${string}` | `...?$RouteFactory.${string}` | `...?$Router.${string}` | `...?$RouteNames.${string}` | `...?$RouterEvents.${string}` | `...?$HttpUrlTransformer.${string}` | `...?$HttpAgentProxy.${string}` | `...?$Http.${string}` | `...?$HttpStatusCode.${string}` | `...?$PageRenderer.${string}` | "...$Helper" | "...$oc" | "...$Settings" | "...$Env" | "...$Protocol" | "...$Secure" | "...$Request" | "...$Response" | "...$Window" | "...$Error" | "...$Dictionary" | "...$CookieTransformFunction" | "...$CookieStorage" | "...$SessionStorage" | "...$MapStorage" | "...$WeakMapStorage" | "...$SessionMapStorage" | "...$Dispatcher" | "...$EventBus" | "...$CacheStorage" | "...$CacheFactory" | "...$Cache" | "...$MetaManager" | "...$ControllerDecorator" | "...$PageStateManagerDecorator" | "...$PageStateManager" | "...$PageFactory" | "...$ComponentUtils" | "...$Utils" | "...$PageHandlerRegistry" | "...$PageManager" | "...$RouteFactory" | "...$Router" | "...$RouteNames" | "...$RouterEvents" | "...$HttpUrlTransformer" | "...$HttpAgentProxy" | "...$Http" | "...$HttpStatusCode" | "...$PageRenderer" | `...$Helper.${string}` | `...$oc.${string}` | `...$Settings.${string}` | `...$Env.${string}` | `...$Protocol.${string}` | `...$Secure.${string}` | `...$Request.${string}` | `...$Response.${string}` | `...$Window.${string}` | `...$Error.${string}` | `...$Dictionary.${string}` | `...$CookieTransformFunction.${string}` | `...$CookieStorage.${string}` | `...$SessionStorage.${string}` | `...$MapStorage.${string}` | `...$WeakMapStorage.${string}` | `...$SessionMapStorage.${string}` | `...$Dispatcher.${string}` | `...$EventBus.${string}` | `...$CacheStorage.${string}` | `...$CacheFactory.${string}` | `...$Cache.${string}` | `...$MetaManager.${string}` | `...$ControllerDecorator.${string}` | `...$PageStateManagerDecorator.${string}` | `...$PageStateManager.${string}` | `...$PageFactory.${string}` | `...$ComponentUtils.${string}` | `...$Utils.${string}` | `...$PageHandlerRegistry.${string}` | `...$PageManager.${string}` | `...$RouteFactory.${string}` | `...$Router.${string}` | `...$RouteNames.${string}` | `...$RouterEvents.${string}` | `...$HttpUrlTransformer.${string}` | `...$HttpAgentProxy.${string}` | `...$Http.${string}` | `...$HttpStatusCode.${string}` | `...$PageRenderer.${string}` | Constructor<Extension<any, any, any>> | AbstractConstructor<Extension<any, any, any>> | [Constructor<Extension<any, any, any>> | AbstractConstructor<Extension<any, any, any>>, { optional: true }])[]

Inherited from

RouteFactoryOptions.extensions

Defined in

packages/core/src/router/Router.ts:44


headers

Optional headers: UnknownParameters

Defined in

packages/core/src/router/Router.ts:59


httpStatus

Optional httpStatus: number

Defined in

packages/core/src/router/Router.ts:60


managedRootView

managedRootView: unknown

Inherited from

RouteFactoryOptions.managedRootView

Defined in

packages/core/src/router/Router.ts:38


middlewares

middlewares: RouterMiddleware[]

Inherited from

RouteFactoryOptions.middlewares

Defined in

packages/core/src/router/Router.ts:43


onlyUpdate

onlyUpdate: boolean | (controller: RouteController, view: unknown) => boolean

Inherited from

RouteFactoryOptions.onlyUpdate

Defined in

packages/core/src/router/Router.ts:39


viewAdapter

viewAdapter: unknown

Inherited from

RouteFactoryOptions.viewAdapter

Defined in

packages/core/src/router/Router.ts:42