Class: ClientRouter

AbstractRouter._handle

Parameters extracted from the URL path and query.

options?

Partial<RouteOptions>

The options overrides route options defined in the routes.js configuration file.

action?

RouteAction

An action object describing what triggered this routing.

Returns

Promise<void | UnknownParameters>

A promise that resolves when the page is rendered and the result is sent to the client, or displayed if used at the client side.

Inherited from

_handleClick()

_handleClick(event): void

Defined in: packages/core/src/router/ClientRouter.ts:381

Handles a click event. The method performs navigation to the target location of the anchor (if it has one).

The navigation will be handled by the router if the protocol and domain of the anchor's target location (href) is the same as the current, otherwise the method results in a hard redirect.

Parameters

event

MouseEvent

The click event.

Returns

void

_handleFatalError()

_handleFatalError(error): void

Defined in: packages/core/src/router/ClientRouter.ts:336

Handle a fatal error application state. IMA handle fatal error when IMA handle error.

Parameters

error

Error

Returns

void

_handlePopState()

_handlePopState(event): void

Defined in: packages/core/src/router/ClientRouter.ts:357

Handles a popstate event. The method is performed when the active history entry changes.

The navigation will be handled by the router if the event state is defined and event is not defaultPrevented.

Parameters

event

PopStateEvent

The popstate event.

Returns

void

_isHashLink()

_isHashLink(targetUrl): boolean

Defined in: packages/core/src/router/ClientRouter.ts:467

Tests whether the provided target URL contains only an update of the hash fragment of the current URL.

Parameters

targetUrl

string

The target URL.

Returns

boolean

true if the navigation to target URL would result only in updating the hash fragment of the current URL.

_isSameDomain()

_isSameDomain(url?): boolean

Defined in: packages/core/src/router/ClientRouter.ts:490

Tests whether the the protocol and domain of the provided URL are the same as the current.

Parameters

url?

string = ''

The URL.

Returns

boolean

true if the protocol and domain of the provided URL are the same as the current.

_runMiddlewares()

_runMiddlewares(middlewares, params, locals): Promise<void>

Defined in: packages/core/src/router/AbstractRouter.ts:684

Runs provided middlewares in sequence.

Parameters

middlewares

Array of middlewares.

undefined | RouterMiddleware[]

params

Router params that can be mutated by middlewares.

locals

AbstractRouter._runMiddlewares

The locals param is used to pass local data between middlewares.

Returns

Promise<void>

Inherited from

add()

add(name, pathExpression, controller, view, options?): ClientRouter

Defined in: packages/core/src/router/AbstractRouter.ts:167

Adds a new route to router.

Parameters

name

string

The unique name of this route, identifying it among the rest of the routes in the application.

pathExpression

string

A path expression specifying the URL path part matching this route (must not contain a query string), optionally containing named parameter placeholders specified as :parameterName. The name of the parameter is terminated by a forward slash (/) or the end of the path expression string. The path expression may also contain optional parameters, which are specified as :?parameterName. It is recommended to specify the optional parameters at the end of the path expression.

controller

AsyncRouteController

The full name of Object Container alias identifying the controller associated with this route.

view

AsyncRouteView

The full name or Object Container alias identifying the view class associated with this route.

options?

Partial<RouteOptions>

Additional route options, specified how the navigation to the route will be handled. The onlyUpdate can be either a flag signalling whether the current controller and view instances should be kept if they match the ones used by the previous route; or a callback function that will receive the previous controller and view identifiers used in the previously matching route, and returns a boolean representing the value of the flag. This flag is disabled by default. The autoScroll flag signals whether the page should be scrolled to the top when the navigation takes place. This flag is enabled by default.

Returns

AbstractRouter.getBaseUrl

This router.

Throws

Thrown if a route with the same name already exists.

Inherited from

AbstractRouter.add

getBaseUrl()

getBaseUrl(): string

Defined in: packages/core/src/router/AbstractRouter.ts:243

Returns the application's absolute base URL, pointing to the public root of the application.

Returns

string

The application's base URL.

Inherited from

getCurrentRouteInfo()

getCurrentRouteInfo(): object

Defined in: packages/core/src/router/AbstractRouter.ts:271

Returns the information about the currently active route.

Returns

object

params

params: RouteParams<{}>

path

path: string

route

route: AbstractRoute<string | RoutePathExpression>

Throws

Thrown if a route is not define for current path.

Inherited from

AbstractRouter.getCurrentRouteInfo

getDomain()

getDomain(): string

Defined in: packages/core/src/router/AbstractRouter.ts:250

Returns the application's domain in the following form ${protocol}//${host}.

Returns

string

The current application's domain.

Inherited from

AbstractRouter.getDomain

getHost()

getHost(): string

Defined in: packages/core/src/router/AbstractRouter.ts:257

Returns application's host (domain and, if necessary, the port number).

Returns

string

The current application's host.

Inherited from

AbstractRouter.getHost

getPath()

getPath(): string

Defined in: packages/core/src/router/ClientRouter.ts:122

Returns the current path part of the current URL, including the query string (if any).

Returns

string

The path and query parts of the current URL.

Overrides

AbstractRouter.getPath

getProtocol()

getProtocol(): string

Defined in: packages/core/src/router/AbstractRouter.ts:264

Returns the current protocol used to access the application, terminated by a colon (for example https:).

Returns

string

The current application protocol used to access the application.

Inherited from

AbstractRouter.getProtocol

getRouteHandler()

getRouteHandler(name): undefined | AbstractRoute<string | RoutePathExpression> | RouterMiddleware

Defined in: packages/core/src/router/AbstractRouter.ts:220

Returns specified handler from registered route handlers.

Parameters

name

string

The route's unique name.

Returns

undefined | AbstractRoute<string | RoutePathExpression> | RouterMiddleware

Route with given name or undefined.

Inherited from

AbstractRouter.getRouteHandler

getRouteHandlers()

getRouteHandlers(): Map<string, AbstractRoute<string | RoutePathExpression> | RouterMiddleware>

Defined in: packages/core/src/router/AbstractRouter.ts:297

Returns

Map<string, AbstractRoute<string | RoutePathExpression> | RouterMiddleware>

Inherit Doc

Inherited from

AbstractRouter.getRouteHandlers

getRouteHandlersByPath()

getRouteHandlersByPath(path): object

Defined in: packages/core/src/router/AbstractRouter.ts:622

Returns the route matching the provided URL path part (the path may contain a query) and all middlewares preceding this route definition.

Parameters

path

string

The URL path.

Returns

object

The route matching the path and middlewares preceding it or {} (empty object) if no such route exists.

middlewares

middlewares: RouterMiddleware[]

route?

optional route: AbstractRoute<string | RoutePathExpression>

Inherited from

AbstractRouter.getRouteHandlersByPath

getUrl()

getUrl(): string

Defined in: packages/core/src/router/ClientRouter.ts:115

Returns the current absolute URL (including protocol, host, query, etc).

Returns

string

The current absolute URL.

Overrides

AbstractRouter.getUrl

handleError()

handleError(params, options?, locals?): Promise<void | UnknownParameters>

Defined in: packages/core/src/router/ClientRouter.ts:264

Handles an internal server error by responding with the appropriate "internal server error" error page.

Parameters

params

Parameters extracted from the current URL path and query.

options?

Partial<RouteOptions>

The options overrides route options defined in the routes.js configuration file.

locals?

AbstractRouter.handleError

The locals param is used to pass local data between middlewares.

Returns

Promise<void | UnknownParameters>

A promise resolved when the error has been handled and the response has been sent to the client, or displayed if used at the client side.

Overrides

handleNotFound()

handleNotFound(params, options, locals): Promise<void | UnknownParameters>

Defined in: packages/core/src/router/ClientRouter.ts:324

Handles a "not found" error by responding with the appropriate "not found" error page.

Parameters

params

StringParameters

Parameters extracted from the current URL path and query.

options

The options overrides route options defined in the routes.js configuration file.

locals

The locals param is used to pass local data between middlewares.

Returns

Promise<void | UnknownParameters>

A promise resolved when the error has been handled and the response has been sent to the client, or displayed if used at the client side.

Overrides

AbstractRouter.handleNotFound

init()

init(config): ClientRouter

Defined in: packages/core/src/router/ClientRouter.ts:99

Initializes the router with the provided configuration.

Parameters

config

Router configuration. The $Protocol field must be the current protocol used to access the application, terminated by a colon (for example https:). The $Root field must specify the URL path pointing to the application's root. The $LanguagePartPath field must be the URL path fragment used as a suffix to the $Root field that specifies the current language. The $Host field must be the application's domain (and the port number if other than the default is used) in the following form: ${protocol}//${host}.

$Host

string

$LanguagePartPath

string

$Protocol

string

$Root

string

Returns

AbstractRouter.isClientError

Overrides

AbstractRouter.init

isClientError()

isClientError(reason): boolean

Defined in: packages/core/src/router/AbstractRouter.ts:514

Tests, if possible, whether the specified error was caused by the client's action (for example wrong URL or request encoding) or by a failure at the server side.

Parameters

reason

The encountered error.

Error | Error

Returns

boolean

true if the error was caused the action of the client.

Inherited from

isRedirection()

isRedirection(reason): boolean

Defined in: packages/core/src/router/AbstractRouter.ts:521

Tests, if possible, whether the specified error lead to redirection.

Parameters

reason

The encountered error.

Error | Error

Returns

boolean

true if the error was caused the action of the redirection.

Inherited from

AbstractRouter.isRedirection

link()

link(routeName, params): string

Defined in: packages/core/src/router/AbstractRouter.ts:345

Generates an absolute URL (including protocol, domain, etc) for the specified route by substituting the route's parameter placeholders with the provided parameter values.

Parameters

routeName

string

The unique name of the route, identifying the route to use.

params

Parameter values for the route's parameter placeholders. Extraneous parameters will be added as URL query.

Returns

string

An absolute URL for the specified route and parameters.

Inherited from

AbstractRouter.link

listen()

listen(target?): ClientRouter

Defined in: packages/core/src/router/ClientRouter.ts:129

Registers event listeners at the client side window object allowing the router to capture user's history (history pop state - going "back") and page (clicking links) navigation.

The router will start processing the navigation internally, handling the user's navigation to display the page related to the URL resulting from the user's action.

Note that the router will not prevent forms from being submitted to the server.

The effects of this method can be reverted with unlisten. This method has no effect at the server side.

Parameters

target?

EventTarget

Returns

AbstractRouter.listen

This router.

Overrides

redirect()

redirect(url, options?, action?, locals?): void

Defined in: packages/core/src/router/ClientRouter.ts:200

Redirects the client to the specified location.

At the server side the method results in responding to the client with a redirect HTTP status code and the Location header.

At the client side the method updates the current URL by manipulating the browser history (if the target URL is at the same domain and protocol as the current one) or performs a hard redirect (if the target URL points to a different protocol or domain).

The method will result in the router handling the new URL and routing the client to the related page if the URL is set at the client side and points to the same domain and protocol.

Parameters

url

string

The URL to which the client should be redirected.

options?

Partial<RouteOptions>

The options overrides route options defined in the routes.js configuration file.

action?

RouteAction

An action object describing what triggered this routing.

locals?

AbstractRouter.redirect

The locals param is used to pass local data between middlewares.

Returns

void

Overrides

remove()

remove(name): ClientRouter

Defined in: packages/core/src/router/AbstractRouter.ts:211

Removes the specified route from the router's known routes.

Parameters

name

string

The route's unique name, identifying the route to remove.

Returns

AbstractRouter.remove

This router.

Inherited from

route()

route(path, options?, action?, locals?): Promise<void | UnknownParameters>

Defined in: packages/core/src/router/ClientRouter.ts:229

Routes the application to the route matching the providing path, renders the route page and sends the result to the client.

Parameters

path

string

The URL path part received from the client, with optional query.

options?

Partial<RouteOptions>

The options overrides route options defined in the routes.js configuration file.

action?

RouteAction

An action object describing what triggered this routing.

locals?

The locals param is used to pass local data between middlewares.

Returns

Promise<void | UnknownParameters>

A promise resolved when the error has been handled and the response has been sent to the client, or displayed if used at the client side.

Overrides

AbstractRouter.route

unlisten()

unlisten(target?): ClientRouter

Defined in: packages/core/src/router/ClientRouter.ts:154

Unregisters event listeners at the client side window object allowing the router to capture user's history (history pop state - going "back") and page (clicking links) navigation.

The router will stop processing the navigation internally, handling the user's navigation to display the page related to the URL resulting from the user's action.

Note that the router will not prevent forms from being submitted to the server.

The effects of this method can be reverted with unlisten. This method has no effect at the server side.

Parameters

target?

EventTarget

Returns

AbstractRouter.unlisten

This router.

Overrides

unlistenAll()

unlistenAll(): this

Defined in: packages/core/src/router/ClientRouter.ts:188

Handles the cleanup and unregisters all registered router listeners.

Returns

this

Overrides

AbstractRouter.unlistenAll

use()

use(middleware): ClientRouter

Defined in: packages/core/src/router/AbstractRouter.ts:199

Adds a new middleware to router.

Parameters

middleware

RouterMiddleware

Middleware function accepting routeParams as a first argument, which can be mutated and locals object as second argument. This can be used to pass data between middlewares.

Returns