Askr
Generated API snapshot

@askrjs/askr/router

Exports from the declarations published in @askrjs/askr 0.0.59. Signatures are generated from the installed artifact.

  • @askrjs/askr/router0.0.59

Exports

This entrypoint publishes 85 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

allowtype

allow: () => AccessAllowDecision

createRouteRegistrytype

createRouteRegistry: (definition: RouteDefinition, options?: RegisterRoutesOptions) => RouteRegistry

currentRoutetype

currentRoute: <TParams extends RouteParams = RouteParams>() => RouteSnapshot<TParams>

defertype

defer: <T>(promise: PromiseLike<T>) => Deferred<T>

denytype

deny: (status: AccessDenyStatus) => AccessDenyDecision

fallbacktype

fallback: (Component: RouteComponent) => void

forbiddentype

forbidden: () => AccessDenyDecision

grouptype

group: (options: GroupHelperOptions, fn: RouteDefinition) => void

indextype

index: (Component: RouteComponent, options?: RouteOptions) => void

isDeferredtype

isDeferred: <T = unknown>(value: unknown) => value is Deferred<T>

lazytype

lazy: <TComponent extends AnyRouteComponent>(factory: () => Promise<{ default: TComponent; } | TComponent>) => LazyRouteComponent<TComponent>

notFoundtype

notFound: () => AccessDenyDecision

Outlettype

Outlet: () => JSXElement

pagetype

page: { <const TPath extends string>(path: TPath, Component: RouteComponent<RoutePathParams<TPath>>, fn: RouteDefinition): void; <const TPath extends string, TComponent extends AnyRouteComponent>(path: TPath, Component: CompatibleRouteComponent<TPath, TComponent>, fn: RouteDefinition): void; <const TPath extends string>(path: TPath, Component: RouteComponent<RoutePathParams<TPath>>, options: PageHelperOptions, fn: RouteDefinition): void; <const TPath extends string, TComponent extends AnyRouteComponent>(path: TPath, Component: CompatibleRouteComponent<TPath, TComponent>, options: PageHelperOptions, fn: RouteDefinition): void; }

reconcileRouteMetatype

reconcileRouteMeta: (meta: Readonly<RouteMeta>, target?: Document) => void

redirecttype

redirect: (to: string, init?: { status?: AccessRedirectStatus; replace?: boolean; }) => AccessRedirectDecision

registerRoutestype

registerRoutes: (definition: RouteDefinition, options?: RegisterRoutesOptions) => void

Resolvetype

Resolve: <T>(props: ResolveProps<T>) => JSXElement

resolveRouteMetatype

resolveRouteMeta: (record: RouteRecord, context: RouteContext) => Promise<Readonly<RouteMeta>>

resolveRouteRequesttype

resolveRouteRequest: (target: string, options?: RouteRequestOptions) => RouteRequestResult | Promise<RouteRequestResult>

routetype

route: { <const TPath extends string, const TSearchSchema extends ObjectSchema<RouteSearch> | undefined = undefined>(path: TPath, Component: RouteComponent<RoutePathParams<TPath>>, options?: RouteOptions<RoutePathParams<TPath>, TSearchSchema>): RouteRef<RoutePathParams<TPath>, RouteRefSearch<TSearchSchema>>; <const TPath extends string, TComponent extends AnyRouteComponent, const TSearchSchema extends ObjectSchema<RouteSearch> | undefined = undefined>(path: TPath, Component: CompatibleRouteComponent<TPath, TComponent>, options?: RouteOptionsForComponent<TPath, TComponent, TSearchSchema>): RouteRef<RoutePathParams<TPath>, RouteRefSearch<TSearchSchema>>; }

totype

to: <TParams extends RouteParams, TSearch extends RouteSearch = RouteSearch>(route: RouteRef<TParams, TSearch>, params: TParams, search?: TSearch) => RouteDestination

updateRouteQuerytype

updateRouteQuery: (updates: RouteQueryUpdates | RouteQueryUpdater, options?: UpdateRouteQueryOptions) => void