@jupyterlite

@jupyterlite / @jupyterlite/application / ILiteRouter

Interface: ILiteRouter#

Defined in: packages/application/src/router.ts:27

An interface for the custom URL router provider.

Provides IRouter, plus the additional methods to transform /path/-based routes

Extends#

  • IRouter

Properties#

addTransformer()#

addTransformer: (transformer) => void

Defined in: packages/application/src/router.ts:31

Add a URL transformer

Parameters#

transformer#

IURLTransformer

Returns#

void

base#

readonly base: string

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:71

The base URL for the router.

Inherited from#

IRouter.base

commands#

readonly commands: CommandRegistry

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:75

The command registry used by the router.

Inherited from#

IRouter.commands

current#

readonly current: ILocation

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:79

The parsed current URL of the application.

Inherited from#

IRouter.current

routed#

readonly routed: ISignal<IRouter, ILocation>

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:83

A signal emitted when the router routes a route.

Inherited from#

IRouter.routed

stop#

readonly stop: Token<void>

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:88

If a matching rule’s command resolves with the stop token during routing, no further matches will execute.

Inherited from#

IRouter.stop

Methods#

register()#

register(options): IDisposable

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:104

Register a rule that maps a path pattern to a command.

Parameters#

options#

IRegisterOptions

The route registration options.

Returns#

IDisposable

A disposable that removes the registered rule from the router.

Inherited from#

IRouter.register

reload()#

reload(): void

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:108

Cause a hard reload of the document.

Returns#

void

Inherited from#

IRouter.reload

route()#

route(url): void

Defined in: node_modules/@jupyterlab/application/lib/tokens.d.ts:118

Route a specific path to an action.

Parameters#

url#

string

The URL string that will be routed.

Notes#

If a pattern is matched, its command will be invoked with arguments that match the IRouter.ILocation interface.

Returns#

void

Inherited from#

IRouter.route