fp-ts-routing/lib/route.d.ts

A type-safe routing library for TypeScript

/**
 * @category routes
 * @since 0.4.0
 */
export type QueryValues = string | Array<string> | undefined;
/**
 * @category routes
 * @since 0.4.0
 */
export interface Query {
    [key: string]: QueryValues;
}
/**
 * @category routes
 * @since 0.4.0
 */
export declare class Route {
    readonly parts: Array<string>;
    readonly query: Query;
    /**
     * @since 0.4.0
     */
    static empty: Route;
    constructor(parts: Array<string>, query: Query);
    /**
     * @since 0.4.0
     */
    static isEmpty(r: Route): boolean;
    /**
     * @since 0.4.0
     */
    static parse(s: string, decode?: boolean): Route;
    /**
     * @since 0.4.0
     */
    toString(encode?: boolean): `/${string}`;
}