Type Alias QueryIndexData

Type Declaration

• Optionalcase_sensitive?: boolean

• Optionalfilter?: string

• Optionallines_after?: number

  How many lines after each result to return with it, from the same document.

• Optionallines_before?: number

  How many lines before each result to return with it, from the same document.

• Optionalmode?: "regex" | "literal"

• Optionalmultiline?: boolean

  Let a match span lines. Without it a pattern matches within one line, ^ and $ mark the line's edges, and a character class never matches a line break; a pattern that contains a line break is rejected. With it the pattern is matched against the whole document, ^ and $ still mark line edges, \A and \z mark the document's edges, and a match may contain line breaks.

• pattern: string

• Optionalwhole_word?: boolean