Interface FuzzyIndexJSON

A saved index: version 1.

interface FuzzyIndexJSON {
    v: 1;
    fields: Record<string, number>;
    passageFields: string[];
    editMinLength: number;
    passages: number;
    passageWidth: number;
    documents: [id: string, fields: Record<string, string | string[]>][];
}

Properties

v fields passageFields editMinLength passages passageWidth documents

Properties

v

v: 1

The format's version.

fields

fields: Record<string, number>

Each field's name and weight.

passageFields

passageFields: string[]

The fields passages are taken from, in order.

editMinLength

editMinLength: number

The fewest letters for a match one edit away.

passages

passages: number

The most passages a hit shows.

passageWidth

passageWidth: number

About how many characters a passage keeps.

documents

documents: [id: string, fields: Record<string, string | string[]>][]

Each document as its id and its fields, in the order they were added.

Settings

Member Visibility

Theme

On This Page

vfieldspassageFieldseditMinLengthpassagespassageWidthdocuments