UNPKG

@roxi/routify

Version:

58 lines (57 loc) 1.89 kB
export class Route { /** * @param {Router} router * @param {string} url * @param {UrlState} mode * @param {Object} state a state to attach to the route */ constructor(router: Router, url: string, mode: UrlState, state?: any); /** @type {RouteFragment[]} */ allFragments: RouteFragment[]; /** @type {RouteFragment[]} only fragments with components */ fragments: RouteFragment[]; /** @type {RoutifyLoadReturn} */ load: RoutifyLoadReturn; /** @type {Route} */ prevRoute: Route; /** @type {Route} */ nextRoute: Route; sourceUrl: URL; router: import("../index.js").RouterClass; mode: UrlState; state: any; params: any; url: string; rendered: Promise<import("../renderer/RenderContext.js").RenderContext[]>; log: any; get fragmentParams(): any; get queryParams(): { [x: string]: string; }; get leaf(): RouteFragment; get isPendingOrPrefetch(): any; get isActive(): boolean; loadRoute(): Promise<boolean>; /** * converts async module functions to sync functions */ loadComponents(): Promise<boolean>; runPreloads(): Promise<boolean | this>; runBeforeUrlChangeHooks(): Promise<any>; get meta(): {}; /** * @param {RNodeRuntime} node the node that corresponds to the fragment * @param {String=} urlFragment a fragment of the url (fragments = url.split('/')) * @param {Object<string, any>=} params * @returns {RouteFragment} */ createFragment(node: RNodeRuntime, urlFragment?: string | undefined, params?: { [x: string]: any; } | undefined): RouteFragment; /** * creates fragments. A fragment is the section between each / in the URL */ _createFragments(pathname: any): RouteFragment[]; _createUrl(): string; } import { RouteFragment } from './RouteFragment.js';