Interface ParamMatcherResult

Represents the result of a params matcher test.

interface ParamMatcherResult {
    deprecatedParams: ParamDefinition[];
    matches: boolean;
    missingParams: ParamDefinition[];
    params: undefined | Map<string, unknown>;
    unexpectedParams: string[];
}

Properties

deprecatedParams: ParamDefinition[]

Params that are deprecated.

matches: boolean

Indicates whether the params match the param definitions.

missingParams: ParamDefinition[]

Required params that are missing.

params: undefined | Map<string, unknown>

Params as passed to the matcher, but with deprecated params mapped to their substitute, or undefined if the match is not successful.

unexpectedParams: string[]

Params that are not expected.