Stone.js API
    Preparing search index...

    Interface IRoute

    Describes a route definition, including its URI, method, and parameters.

    interface IRoute {
        getOption?: <TReturn = unknown>(
            key: string,
            fallback?: TReturn,
        ) => TReturn;
        getOptions: <TReturn = unknown>(keys: string[]) => Record<string, TReturn>;
        getParam: <TReturn = unknown>(name: string, fallback?: TReturn) => TReturn;
        method: HttpMethod;
        params: Record<string, unknown>;
        uri: string;
    }
    Index
    getOption? getOptions getParam method params uri
    getOption?: <TReturn = unknown>(key: string, fallback?: TReturn) => TReturn

    One option by name, which is how a route's own declarations are read.

    Optional in the contract because this package duck-types a route rather than depending on the router: an implementer that only answers getOptions stays valid.

    getOptions: <TReturn = unknown>(keys: string[]) => Record<string, TReturn>
    getParam: <TReturn = unknown>(name: string, fallback?: TReturn) => TReturn
    method: HttpMethod
    params: Record<string, unknown>
    uri: string

    Settings
    Member Visibility

    On This Page
    Properties