@aurelia/route-recognizer/dist/types/index.d.ts

[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [![CircleCI](https://circleci.com/

export interface IConfigurableRoute<T> {
    readonly path: string;
    readonly caseSensitive?: boolean;
    readonly handler: T;
}
export declare class Parameter {
    readonly name: string;
    readonly isOptional: boolean;
    readonly isStar: boolean;
    readonly pattern: RegExp | null;
    constructor(name: string, isOptional: boolean, isStar: boolean, pattern: RegExp | null);
    satisfiesPattern(value: string): boolean;
}
export declare class ConfigurableRoute<T> implements IConfigurableRoute<T> {
    readonly path: string;
    readonly caseSensitive: boolean;
    handler: T;
    constructor(path: string, caseSensitive: boolean, handler: T);
}
export declare class Endpoint<T> {
    readonly route: ConfigurableRoute<T>;
    readonly params: readonly Parameter[];
    private _residualEndpoint;
    get residualEndpoint(): Endpoint<T> | null;
    constructor(route: ConfigurableRoute<T>, params: readonly Parameter[]);
    equalsOrResidual(other: Endpoint<T> | null | undefined): boolean;
}
export declare class RecognizedRoute<T> {
    readonly endpoint: Endpoint<T>;
    readonly params: Readonly<Record<string, string | undefined>>;
    readonly path: string;
    constructor(endpoint: Endpoint<T>, path: string, params: Readonly<Record<string, string | undefined>>);
}
/**
 * Reserved parameter name that's used when registering a route with residual star segment (catch-all).
 */
export declare const RESIDUE: "$$residue";
export declare class RouteRecognizer<T> {
    private readonly rootState;
    private readonly cache;
    private readonly endpointLookup;
    add(routeOrRoutes: IConfigurableRoute<T> | readonly IConfigurableRoute<T>[], addResidue?: boolean, parentPath?: string | null): void;
    private $add;
    recognize(path: string, relativeTo?: RecognizedRoute<T>[] | null): RecognizedRoute<T>[] | null;
    private $recognize;
    getEndpoint(path: string): Endpoint<T> | null;
}
//# sourceMappingURL=index.d.ts.map