goodrouter/types/router-options.d.ts

a good router

/**
 * @description
 * Default options to be passed to the router
 */
export declare const defaultRouterOptions: {
    /**
     * @description
     * Default encoding function to use, this is the encodeUriComponent function by default
     *
     * @param decodedValue value to be encoded
     * @returns encoded value
     */
    parameterValueEncoder: (decodedValue: string) => string;
    /**
     * @description
     * Default decoding function to use, this is the decodeURIComponent function by default
     *
     * @param encodedValue value to be decoded
     * @returns decoded value
     */
    parameterValueDecoder: (encodedValue: string) => string;
    /**
     * Use `{` and `}` as a default for matching placeholders in the route templates.
     */
    parameterPlaceholderRE: RegExp;
    /**
     * Assume a maximum parameter value length of 50
     */
    maximumParameterValueLength: number;
};
/**
 * @description
 * Options to be passed to the router
 */
export interface RouterOptions {
    /**
     * @description
     * This function wil be used on each parameter value when parsing a route
     *
     * @param decodedValue value to be encoded
     * @returns encoded value
     */
    parameterValueEncoder?: (decodedValue: string) => string;
    /**
     * @description
     * This function wil be used on each parameter value when constructing a route
     *
     * @param encodedValue value to be decoded
     * @returns decoded value
     */
    parameterValueDecoder?: (encodedValue: string) => string;
    /**
     * Regular expression to use when parsing placeholders from a route template. This regular
     * expression must have the global option set! Defaults to `/\{(.*?)\}/gu`.
     */
    parameterPlaceholderRE?: RegExp;
    /**
     * The expected maximum character length of a parameter value. No parameter value should
     * be longer than what is specified here!
     */
    maximumParameterValueLength?: number;
}