Class Checker

Checks text paragraph by paragraph. Only a changed paragraph is checked again: an unchanged one takes its findings from the cache, moved to its new position.

Index

Constructors

Accessors

cachedParagraphs

Methods

check complete setLexicon suggest

Constructors

constructor

new Checker(): Checker

Returns Checker

Accessors

cachedParagraphs

get cachedParagraphs(): number

Returns number

Methods

check

check(text: string, options?: CheckOptions): Finding[]
Every finding in a text, in order, with offsets into that text.
Parameters
- text: string
- options: CheckOptions = {}
Returns Finding[]

complete

complete(prefix: string, lang: Variety, limit?: number): Completion[]
Words that begin with what is being typed, attested ones first.
Parameters
- prefix: string
- lang: Variety
- Optionallimit: number
Returns Completion[]

setLexicon

setLexicon(lexicon: Lexicon): void
Rule tests and the first moments of a session have no lexicon: rules that need one find nothing.
Parameters
- lexicon: Lexicon
Returns void

suggest

suggest(word: string, lang: Variety): string[]
Spelling suggestions for one word, for a finding whose lookup asks for them.
Parameters
- word: string
- lang: Variety
Returns string[]