@gluonjs/router / packages/router/src / RouteRecordRaw

Interface: RouteRecordRaw

Properties

alias?

readonly optional alias?: string | readonly string[]

beforeEnter?

readonly optional beforeEnter?: NavigationGuard | readonly NavigationGuard[]

children?

readonly optional children?: readonly RouteRecordRaw[]

component?

readonly optional component?: RouteComponentSource

components?

readonly optional components?: Readonly<Record<string, RouteComponentSource>>

data?

readonly optional data?: Readonly<Record<string, unknown>>

meta?

readonly optional meta?: Readonly<Record<string, unknown>>

name?

readonly optional name?: string

path

readonly path: string

redirect?

readonly optional redirect?: RouteLocationRaw<RouteNamedMap> | ((to) => RouteLocationRaw<RouteNamedMap>)

Example

Declare a route's path, name, component source, metadata, aliases, children, redirects, and entry guards before matcher compilation:

import { html } from '@gluonjs/core';
import {
  createRouterMatcher,
  isLazyRouteComponent,
  lazyRoute,
  type MatcherResolution,
  type RouteComponent,
  type RouteComponentSource,
  type RouteData,
  type RouteMeta,
  type RouteParamPrimitive,
  type RouteParams,
  type RouteParamsRaw,
  type RouteRecordNormalized,
  type RouteRecordRaw,
  type RouterMatcher,
} from '@gluonjs/router';

const productId: RouteParamPrimitive = 42;
const rawParams = { id: productId } satisfies RouteParamsRaw;
const ProductPage: RouteComponent = ({ route }) => html`<h1>${route.params.id}</h1>`;
const source: RouteComponentSource = lazyRoute(async () => ProductPage);
const meta = { requiresAuth: false } satisfies RouteMeta;
const data = { section: 'catalog', cache: 'request-free' } satisfies RouteData;
const record = { path: '/products/:id', name: 'product', component: source, meta, data } satisfies RouteRecordRaw;
const matcher: RouterMatcher = createRouterMatcher([record]);
const resolution: MatcherResolution = matcher.resolveName('product', rawParams);
const params: RouteParams = resolution.params;
const normalized: RouteRecordNormalized = resolution.matched[0]!;
console.log(resolution.path, params.id, normalized.meta, normalized.data, isLazyRouteComponent(source));