Interface FixSearchQuery

Options for a fuzzy text search query against fix identifiers.

interface FixSearchQuery {
    limit?: number;
    minScore?: number;
    text: string;
    useCodes?: ReadonlySet<FixUseCode>;
}

Properties

limit?: number

Maximum number of results to return. Defaults to 20.

minScore?: number

Minimum match score (exclusive) in [0, 1] a result must reach. Defaults to 0, which keeps every match. Raise it to drop weak fuzzy matches.

text: string

Search text, matched fuzzily and case-insensitively against each fix's identifier.

useCodes?: ReadonlySet<FixUseCode>

Optional set of use codes to include. When omitted, all use codes are included.