createRouter

Creates a router.

Nothing loads until Router.ready (or the RouterProvider, on the client) is called, so a server can await the first load before rendering. Each router owns its listeners and timers; Router.dispose removes them all.

Import#

import { createRouter } from "@shadow-js/router";

Signature#

function createRouter(options: RouterOptions): Router

Parameters#

Returns#

The router.

Throws#

• Error when two routes match the same paths (the navigator's conflict report).
• TypeError when two routes share an id, a feature is given twice, or a route uses an option whose feature is not given.

Examples#

const router = createRouter({ routes: [home, posts], features: [scrollRestoration()] });
await router.ready();