`@stesura/contract-check`

Defined terms: where each is defined, what the definition says and where it is used, and what is wrong with them (the findings). The UI is @stesura/contract-check-react; setup and behaviour are in the Contract check guide.

Plugin

`contractCheckPlugin`

Parameters:

Name	Type	Default
`options`	`ContractCheckPluginOptions`

Returns:

Plugin<ContractCheckPluginState>

`ContractCheckPluginOptions`

Name	Type	Default
`settings`	`CheckSettings`
`debounceMs`	`number` Quiet time after the last edit before the index is rebuilt. Default 500 ms.
`underlines`	`boolean` Underline defined terms and tint open findings. Default true.
`enabled`	`boolean \| (() => boolean)` Checks at all. Off, nothing is built or drawn until setContractCheckEnabled turns it on. A function is read once, when the state is created (a stored user preference). Default true.

`ContractCheckPluginState`

Name	Type	Default
`index`	`TermIndex \| null` `null` until the first build. Positions are those of the document it was built on.
`findings`	`CheckFinding[]` From the same build as `index`; read them mapped through selectCheckFindings.
`mapping`	`Mapping` From the index’s document to the current one: empty right after a build.
`stale`	`boolean` The index predates the current text.
`settings`	`ResolvedCheckSettings`
`underlines`	`boolean`
`visible`	`CheckRange \| null` The range the UI reports as on screen; `null` decorates the whole document.
`focusId`	`string \| null` The finding the panel points at: its ranges are outlined.
`step`	`{ id: string; pos: number; } \| null` The range the panel last stepped to, by its start in the current document (mapped through edits, so it stays on the same occurrence). While its finding is focused, only that range is outlined.
`enabled`	`boolean`
`decorations`	`DecorationSet`

`getContractCheckState`

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

ContractCheckPluginState | undefined

`findDefinedTerm`

A defined term by id, its definition range mapped to the current document. A definition deleted since the last build is not found until the next one, even if an undo brought it back: two transactions share no mirror, so its range has collapsed.

Parameters:

Name	Type	Default
`state`	`EditorState`
`id`	`string`

Returns:

DefinedTerm | undefined

`goToDefinition`

Selects a term’s definition and reveals it, like goToCheckFinding.

Parameters:

Name	Type	Default
`view`	`EditorView`
`id`	`string`

Returns:

boolean

`goToDefinitionAtSelection`

Goes to the definition of the term at the caret; a host binds it to a key.

Parameters:

Name	Type	Default
`view`	`EditorView`

Returns:

boolean

`termAtSelection`

The underlined term the caret sits in: how keyboard users reach the hover card.

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

{ termId: string; definition: boolean; from: number; } | null

`setContractCheckVisibleRange`

The UI reports what is on screen; underlines outside it are not drawn.

Parameters:

Name	Type	Default
`view`	`EditorView`
`range`	`CheckRange`

Returns:

void

`setContractCheckUnderlines`

Parameters:

Name	Type	Default
`view`	`EditorView`
`on`	`boolean`

Returns:

void

`setContractCheckSettings`

Replaces the settings the plugin was created with (a host endpoint’s answer) and rebuilds.

Parameters:

Name	Type	Default
`view`	`EditorView`
`settings`	`CheckSettings`

Returns:

void

`focusCheckFinding`

Outlines one finding’s ranges (or clears the outline): the panel’s hover. With range, it steps to that range (an index into the finding’s ranges as selectCheckFindings lists them): only it is outlined while the finding is focused, and the step follows edits.

Parameters:

Name	Type	Default
`id`	`string`
`range`	`number`

Returns:

Command

`goToCheckFinding`

Selects a finding’s first range and reveals it. React callers that reveal with editor-react’s revealPos use checkFindingRange instead.

Parameters:

Name	Type	Default
`view`	`EditorView`
`id`	`string`

Returns:

boolean

`TERM_CLASS`

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`DEFINITION_CLASS`

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`TERM_ID_ATTR`

On every underlined span: the defined term’s id.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`ISSUE_CLASS`

An open error or warning; with -error or -warning. Hints are shown only when focused.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`FOCUS_CLASS`

The ranges of the finding the panel points at.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

Findings

`selectCheckFindings`

The findings read API: what a panel, a status bar or a joined panel renders.

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

CheckFindingsView

`CheckFindingsView`

Name	Type	Default
`installed`	`boolean` The plugin is in the editor.
`enabled`	`boolean` Checking is on; off, there are no findings (setContractCheckEnabled).
`stale`	`boolean` Until the first build lands, and from an edit until the rebuild.
`index`	`TermIndex \| null`
`findings`	`ReviewedCheckFinding[]` In document order. A range whose text was deleted since the build is dropped.

`ReviewedCheckFinding`

A finding as the UI shows it: ranges mapped to the current document, with its review state and, once the panel stepped through it, the index of the range it is on.

Name	Type	Default
`id`	`string` Hash of rule, scope and normalised term (plus the block id for a final check): stable across edits elsewhere and re-imports.
`rule`	`CheckRuleId`
`category`	`CheckCategory`
`severity`	`CheckSeverity`
`scope`	`string` The scope (`CheckScope.id`) the finding belongs to.
`message`	`string` English, like format-lint’s; the UI shows it under a translated rule title.
`evidence`	`CheckEvidence[]` At most three quotes, in document order.
`ranges`	`CheckRange[]` Document ranges, in document order. Positions of the document the finding was collected on.
`blockIds`	`string[]` The `id`s of the blocks the ranges sit in, in document order, each once.
`fixable`	`boolean` Has a fix `applyCheckFixes` applies: CHK-30’s conversion to a live cross-reference.
`confidence`	`number` Heuristic rules only (CHK-1, CHK-5): how sure, 0 to 1.
`band`	`ConfidenceBand` Heuristic rules only: `recommend` or `possible`; `silent` findings are not reported.
`status`	`CheckReviewStatus`
`step`	`number \| null`

`runContractCheck`

The index and the findings from one build: what the plugin, the CLI and the corpus runner use.

Parameters:

Name	Type	Default
`doc`	`Node`
`options`	`BuildTermIndexOptions`

Returns:

CheckResult

`collectCheckFindings`

What is wrong with the document’s defined terms. Pure: the same document gives the same findings.

Parameters:

Name	Type	Default
`doc`	`Node`
`options`	`BuildTermIndexOptions`

Returns:

CheckFinding[]

`CHECK_RULES`

Name	Type	Default
`length`	`number`
`toString`	`() => string`
`toLocaleString`	`{ (): string; (locales: string \| string[], options?: (NumberFormatOptions & DateTimeFormatOptions) \| undefined): string; }`
`concat`	`{ (...items: ConcatArray<CheckRuleId>[]): CheckRuleId[]; (...items: (CheckRuleId \| ConcatArray<CheckRuleId>)[]): CheckRuleId[]; }`
`join`	`(separator?: string \| undefined) => string`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => CheckRuleId[]`
`indexOf`	`(searchElement: CheckRuleId, fromIndex?: number \| undefined) => number`
`lastIndexOf`	`(searchElement: CheckRuleId, fromIndex?: number \| undefined) => number`
`every`	`{ <S extends CheckRuleId>(predicate: (value: CheckRuleId, index: number, array: readonly CheckRuleId[]) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: CheckRuleId, index: number, array: readonly CheckRuleId[]) => unknown, thisArg?: any): boolean; }`
`some`	`(predicate: (value: CheckRuleId, index: number, array: readonly CheckRuleId[]) => unknown, thisArg?: any) => boolean`
`forEach`	`(callbackfn: (value: CheckRuleId, index: number, array: readonly CheckRuleId[]) => void, thisArg?: any) => void`
`map`	`<U>(callbackfn: (value: CheckRuleId, index: number, array: readonly CheckRuleId[]) => U, thisArg?: any) => U[]`
`filter`	`{ <S extends CheckRuleId>(predicate: (value: CheckRuleId, index: number, array: readonly CheckRuleId[]) => value is S, thisArg?: any): S[]; (predicate: (value: CheckRuleId, index: number, array: readonly CheckRuleId[]) => unknown, thisArg?: any): CheckRuleId[]; }`
`reduce`	`{ (callbackfn: (previousValue: CheckRuleId, currentValue: CheckRuleId, currentIndex: number, array: readonly CheckRuleId[]) => CheckRuleId): CheckRuleId; (callbackfn: (previousValue: CheckRuleId, currentValue: CheckRuleId, currentIndex: number, array: readonly CheckRuleId[]) => CheckRuleId, initialValue: CheckRuleId...`
`reduceRight`	`{ (callbackfn: (previousValue: CheckRuleId, currentValue: CheckRuleId, currentIndex: number, array: readonly CheckRuleId[]) => CheckRuleId): CheckRuleId; (callbackfn: (previousValue: CheckRuleId, currentValue: CheckRuleId, currentIndex: number, array: readonly CheckRuleId[]) => CheckRuleId, initialValue: CheckRuleId...`
`find`	`{ <S extends CheckRuleId>(predicate: (value: CheckRuleId, index: number, obj: readonly CheckRuleId[]) => value is S, thisArg?: any): S \| undefined; (predicate: (value: CheckRuleId, index: number, obj: readonly CheckRuleId[]) => unknown, thisArg?: any): CheckRuleId \| undefined; }`
`findIndex`	`(predicate: (value: CheckRuleId, index: number, obj: readonly CheckRuleId[]) => unknown, thisArg?: any) => number`
`entries`	`() => ArrayIterator<[number, CheckRuleId]>`
`keys`	`() => ArrayIterator<number>`
`values`	`() => ArrayIterator<CheckRuleId>`
`includes`	`(searchElement: CheckRuleId, fromIndex?: number \| undefined) => boolean`
`flatMap`	`<U, This = undefined>(callback: (this: This, value: CheckRuleId, index: number, array: CheckRuleId[]) => U \| readonly U[], thisArg?: This \| undefined) => U[]`
`flat`	`<A, D extends number = 1>(this: A, depth?: D \| undefined) => FlatArray<A, D>[]`
`at`	`(index: number) => CheckRuleId \| undefined`
`__@iterator@6565`	`() => ArrayIterator<CheckRuleId>`
`__@unscopables@6567`	`{ readonly [x: number]: boolean \| undefined; readonly length?: boolean; toString?: boolean; toLocaleString?: boolean; concat?: boolean; join?: boolean; slice?: boolean; indexOf?: boolean; lastIndexOf?: boolean; ... 17 more ...; readonly [Symbol.unscopables]?: boolean; }`

`DEFAULT_RULES`

CHK-5 reports 70 orphan short forms per 100 pages until its list is grown (Phase 0).

Name	Type	Default
`CHK-1`	`boolean`
`CHK-2`	`boolean`
`CHK-3`	`boolean`
`CHK-4`	`boolean`
`CHK-5`	`boolean`
`CHK-6`	`boolean`
`CHK-10`	`boolean`
`CHK-22`	`boolean`
`CHK-30`	`boolean`
`CHK-31`	`boolean`
`CHK-32`	`boolean`
`CHK-33`	`boolean`
`CHK-34`	`boolean`
`CHK-35`	`boolean`
`CHK-36`	`boolean`
`CHK-40`	`boolean`
`CHK-41`	`boolean`
`CHK-42`	`boolean`
`CHK-43`	`boolean`

Fixes

CHK-30’s fix turns a typed reference into a live cross-reference. Fixes are collected again on the current document and applied in one transaction, so one undo step; while track changes is on they are refused unless forced.

`applyCheckFixes`

Applies fixes with the settings the plugin checks with, in one undo step, in chunks (a bulk command: dispatch it through the editor, or runBulkCommand headless). Refuses while track changes is on (see checkFixesBlockedReason); force applies anyway.

Parameters:

Name	Type	Default
`selection`	`string[] \| "all"`
`options`	`ApplyCheckFixesOptions`

Returns:

Command

`applyCheckFixesTr`

Applies fixes in one transaction, for composing; applyCheckFixesBulk applies them in chunks. One undo step either way: the findings are collected again on the current document and filtered by id, never replayed from positions held since. "all" takes every fixable finding not ignored.

Parameters:

Name	Type	Default
`selection`	`string[] \| "all"`
`options`	`ApplyCheckFixesOptions`

Returns:

TransactionFn

`checkFixesBlockedReason`

Why fixing is refused right now: every conversion would be a tracked deletion and insertion.

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

string | null

`getCheckFixSummary`

The summary an applyCheckFixesTr left on its transaction.

Parameters:

Name	Type	Default
`tr`	`Transaction`

Returns:

CheckFixSummary | undefined

`ApplyCheckFixesOptions`

Name	Type	Default
`settings`	`CheckSettings \| ResolvedCheckSettings`
`blockedReason`	`(state: EditorState) => string \| null` A reason not to apply (track changes on, by default); `force` overrides it.
`force`	`boolean`

`CheckFixSummary`

Name	Type	Default
`applied`	`CheckFinding[]` The findings fixed, as collected on the document before the fix.
`gone`	`string[]` Requested ids with no fix on the current document.
`blocked`	`string \| null` Set when nothing was applied because of `blockedReason`.
`forced`	`boolean` Applied despite a `blockedReason`.

Review state

`setCheckReviewStatus`

Marks findings ignored, flagged or open again, for every collaborator. Not an undo step: like a task pane’s state, it is not part of the text’s history.

Parameters:

Name	Type	Default
`ids`	`string \| readonly string[]`
`status`	`CheckReviewStatus`

Returns:

Command

`clearCheckReview`

Every finding open again.

Parameters:

This function does not accept any parameters.

Returns:

Command

`getCheckReview`

Review state per finding id; open findings are absent. Shared by collaborators, last write wins.

Parameters:

Name	Type	Default
`state`	`EditorState`

Returns:

Readonly<Record<string, StoredStatus>>

`getCheckReviewStatus`

Parameters:

Name	Type	Default
`state`	`EditorState`
`id`	`string`

Returns:

CheckReviewStatus

`CHECK_REVIEW_ATTR`

The doc attr holding review state: finding id → ignored or flagged.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

Reports

`renderCheckReport`

The findings as a report: Markdown for a reader or an agent, JSON for a program. Sorted in document order, no timestamps: the same document gives the same bytes.

Parameters:

Name	Type	Default
`findings`	`readonly ReportFinding[]`
`index`	`TermIndex`
`options`	`CheckReportOptions`

Returns:

string

`CheckReportOptions`

Name	Type	Default
`format`	`"markdown" \| "json"`
`review`	`Readonly<Record<string, CheckReviewStatus>>` Review state per finding id; a finding that carries a `status` keeps its own.

Index

`buildTermIndex`

The defined terms of a document, where they are defined and where they are used. Pure: the same document gives the same index, in the same order.

Parameters:

Name	Type	Default
`doc`	`Node`
`options`	`BuildTermIndexOptions`

Returns:

TermIndex

`BuildTermIndexOptions`

Name	Type	Default
`settings`	`CheckSettings \| ResolvedCheckSettings`

`normaliseTerm`

Case folded with toLowerCase, never a locale-dependent fold.

Parameters:

Name	Type	Default
`s`	`string`

Returns:

string

Settings

`resolveCheckSettings`

Parameters:

Name	Type	Default
`settings`	`CheckSettings`

Returns:

ResolvedCheckSettings

`parseCheckSettings`

Reads settings from untrusted JSON (a host endpoint): unknown keys and values of the wrong type are dropped, never thrown on.

Parameters:

Name	Type	Default
`json`	`unknown`

Returns:

CheckSettings

`DEFAULT_WEIGHTS`

Calibrated in Phase 0 on the labelled corpus (docs/partially-executed/contract-check-plan.md, “Phase 0 results”); change them only with the corpus runner’s numbers.

Name	Type	Default
`markup`	`number`
`long`	`number`
`quoted`	`number`
`quotePreferred`	`number`
`bold`	`number`
`boldOnce`	`number`
`verb`	`number`
`lead`	`number`
`hereinafter`	`number`
`paren`	`number`
`articleParen`	`number`
`sep`	`number`
`blockStart`	`number`
`run`	`number`
`caps`	`number`
`numbered`	`number`
`cellTerm`	`number`
`allCaps`	`number`
`sentence`	`number`
`lowercase`	`number`
`emptyBody`	`number`
`mention`	`number`
`reference`	`number`
`runIn`	`number`
`capBody`	`number`
`wholeBold`	`number`

`DEFAULT_THRESHOLDS`

Name	Type	Default
`recommend`	`number`
`possible`	`number`

`DEFAULT_PROFILES`

Name	Type	Default
`en`	`LanguageProfile`
`fr`	`LanguageProfile`
`de`	`LanguageProfile`
`nl`	`LanguageProfile`
`it`	`LanguageProfile`
`es`	`LanguageProfile`

`CHECK_LANGUAGES`

Name	Type	Default
`length`	`number`
`toString`	`() => string`
`toLocaleString`	`{ (): string; (locales: string \| string[], options?: (NumberFormatOptions & DateTimeFormatOptions) \| undefined): string; }`
`concat`	`{ (...items: ConcatArray<CheckLanguage>[]): CheckLanguage[]; (...items: (CheckLanguage \| ConcatArray<CheckLanguage>)[]): CheckLanguage[]; }`
`join`	`(separator?: string \| undefined) => string`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => CheckLanguage[]`
`indexOf`	`(searchElement: CheckLanguage, fromIndex?: number \| undefined) => number`
`lastIndexOf`	`(searchElement: CheckLanguage, fromIndex?: number \| undefined) => number`
`every`	`{ <S extends CheckLanguage>(predicate: (value: CheckLanguage, index: number, array: readonly CheckLanguage[]) => value is S, thisArg?: any): this is readonly S[]; (predicate: (value: CheckLanguage, index: number, array: readonly CheckLanguage[]) => unknown, thisArg?: any): boolean; }`
`some`	`(predicate: (value: CheckLanguage, index: number, array: readonly CheckLanguage[]) => unknown, thisArg?: any) => boolean`
`forEach`	`(callbackfn: (value: CheckLanguage, index: number, array: readonly CheckLanguage[]) => void, thisArg?: any) => void`
`map`	`<U>(callbackfn: (value: CheckLanguage, index: number, array: readonly CheckLanguage[]) => U, thisArg?: any) => U[]`
`filter`	`{ <S extends CheckLanguage>(predicate: (value: CheckLanguage, index: number, array: readonly CheckLanguage[]) => value is S, thisArg?: any): S[]; (predicate: (value: CheckLanguage, index: number, array: readonly CheckLanguage[]) => unknown, thisArg?: any): CheckLanguage[]; }`
`reduce`	`{ (callbackfn: (previousValue: CheckLanguage, currentValue: CheckLanguage, currentIndex: number, array: readonly CheckLanguage[]) => CheckLanguage): CheckLanguage; (callbackfn: (previousValue: CheckLanguage, currentValue: CheckLanguage, currentIndex: number, array: readonly CheckLanguage[]) => CheckLanguage, initial...`
`reduceRight`	`{ (callbackfn: (previousValue: CheckLanguage, currentValue: CheckLanguage, currentIndex: number, array: readonly CheckLanguage[]) => CheckLanguage): CheckLanguage; (callbackfn: (previousValue: CheckLanguage, currentValue: CheckLanguage, currentIndex: number, array: readonly CheckLanguage[]) => CheckLanguage, initial...`
`find`	`{ <S extends CheckLanguage>(predicate: (value: CheckLanguage, index: number, obj: readonly CheckLanguage[]) => value is S, thisArg?: any): S \| undefined; (predicate: (value: CheckLanguage, index: number, obj: readonly CheckLanguage[]) => unknown, thisArg?: any): CheckLanguage \| undefined; }`
`findIndex`	`(predicate: (value: CheckLanguage, index: number, obj: readonly CheckLanguage[]) => unknown, thisArg?: any) => number`
`entries`	`() => ArrayIterator<[number, CheckLanguage]>`
`keys`	`() => ArrayIterator<number>`
`values`	`() => ArrayIterator<CheckLanguage>`
`includes`	`(searchElement: CheckLanguage, fromIndex?: number \| undefined) => boolean`
`flatMap`	`<U, This = undefined>(callback: (this: This, value: CheckLanguage, index: number, array: CheckLanguage[]) => U \| readonly U[], thisArg?: This \| undefined) => U[]`
`flat`	`<A, D extends number = 1>(this: A, depth?: D \| undefined) => FlatArray<A, D>[]`
`at`	`(index: number) => CheckLanguage \| undefined`
`__@iterator@6565`	`() => ArrayIterator<CheckLanguage>`
`__@unscopables@6567`	`{ readonly [x: number]: boolean \| undefined; readonly length?: boolean; toString?: boolean; toLocaleString?: boolean; concat?: boolean; join?: boolean; slice?: boolean; indexOf?: boolean; lastIndexOf?: boolean; ... 17 more ...; readonly [Symbol.unscopables]?: boolean; }`

Types

`CheckFinding`

Name	Type	Default
`id`	`string` Hash of rule, scope and normalised term (plus the block id for a final check): stable across edits elsewhere and re-imports.
`rule`	`CheckRuleId`
`category`	`CheckCategory`
`severity`	`CheckSeverity`
`scope`	`string` The scope (`CheckScope.id`) the finding belongs to.
`message`	`string` English, like format-lint’s; the UI shows it under a translated rule title.
`evidence`	`CheckEvidence[]` At most three quotes, in document order.
`ranges`	`CheckRange[]` Document ranges, in document order. Positions of the document the finding was collected on.
`blockIds`	`string[]` The `id`s of the blocks the ranges sit in, in document order, each once.
`fixable`	`boolean` Has a fix `applyCheckFixes` applies: CHK-30’s conversion to a live cross-reference.
`confidence`	`number` Heuristic rules only (CHK-1, CHK-5): how sure, 0 to 1.
`band`	`ConfidenceBand` Heuristic rules only: `recommend` or `possible`; `silent` findings are not reported.

`CheckResult`

What one check run produces: the index and what is wrong with the document.

Name	Type	Default
`index`	`TermIndex`
`findings`	`CheckFinding[]`

`CheckRuleId`

Rule ids, as in docs/partially-executed/contract-check-plan.md.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`CheckCategory`

The plan’s rule families: defined terms, definition layout, bilingual, cross-references, final checks.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`CheckSeverity`

error: the document says something wrong. warning: probably a drafting slip. hint: a judgement call (lowercase uses are often deliberate).

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`CheckEvidence`

A quote from the document that supports a finding, with the block it sits in.

Name	Type	Default
`text`	`string`
`blockId`	`string \| null`

`CheckReviewStatus`

A finding’s review state; open is not stored.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`TermIndex`

Name	Type	Default
`language`	`CheckLanguage`
`scopes`	`CheckScope[]`
`terms`	`DefinedTerm[]`
`usages`	`TermUsage[]`
`candidates`	`DefinitionCandidate[]`

`DefinedTerm`

Name	Type	Default
`id`	`string` Hash of scope and normalised term: stable across edits elsewhere.
`term`	`string`
`kind`	`DefinitionKind`
`scope`	`string`
`language`	`CheckLanguage`
`score`	`number` The weighted signal sum the definition scored (5 or more: see `ResolvedCheckSettings.thresholds`).
`definition`	`CheckRange`
`blockId`	`string \| null` The `id` of the block holding the definition: what reports cite.
`body`	`string` The defining text, read from the document; empty when not found.
`usages`	`number` Uses outside headers, footers and the term’s own definition.

`TermUsage`

Name	Type	Default
`termId`	`string`
`range`	`CheckRange`

`DefinitionCandidate`

A span the detector proposes as a definition.

Name	Type	Default
`key`	`string` `<block index>:<normalised term>`: stable across imports of the same file.
`block`	`number`
`term`	`string`
`language`	`CheckLanguage`
`signals`	`DefinitionSignal[]`
`score`	`number`
`band`	`ConfidenceBand`
`range`	`CheckRange` The term’s range (the quotes excluded).
`source`	`string` Where the candidate came from: `quote`, `bold`, `head`, `cell`, …

`DefinitionKind`

How a definition is laid out; decides where its body is.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`DefinitionSignal`

One scoring signal of a definition candidate.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`ConfidenceBand`

recommend: a definition the index trusts; possible: shown as a finding only; silent: ignored.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`CheckScope`

A region whose definitions belong together. Phase 1 proposes them from language runs.

Name	Type	Default
`id`	`string`
`language`	`CheckLanguage`
`blocks`	`{ first: number; last: number; }` Block indices, inclusive.
`translationOf`	`string` The document’s other-language version, when it is bilingual.

`CheckRange`

A text range in the document.

Name	Type	Default
`from`	`number`
`to`	`number`

`CheckLanguage`

Languages with a profile.

Name	Type	Default
`toString`	`() => string`
`charAt`	`(pos: number) => string`
`charCodeAt`	`(index: number) => number`
`concat`	`(...strings: string[]) => string`
`indexOf`	`(searchString: string, position?: number \| undefined) => number`
`lastIndexOf`	`(searchString: string, position?: number \| undefined) => number`
`localeCompare`	`{ (that: string): number; (that: string, locales?: string \| string[] \| undefined, options?: CollatorOptions \| undefined): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions \| undefined): number; }`
`match`	`{ (regexp: string \| RegExp): RegExpMatchArray \| null; (matcher: { [Symbol.match](string: string): RegExpMatchArray \| null; }): RegExpMatchArray \| null; }`
`replace`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; }`
`search`	`{ (regexp: string \| RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }`
`slice`	`(start?: number \| undefined, end?: number \| undefined) => string`
`split`	`{ (separator: string \| RegExp, limit?: number \| undefined): string[]; (splitter: { [Symbol.split](string: string, limit?: number \| undefined): string[]; }, limit?: number \| undefined): string[]; }`
`substring`	`(start: number, end?: number \| undefined) => string`
`toLowerCase`	`() => string`
`toLocaleLowerCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`toUpperCase`	`() => string`
`toLocaleUpperCase`	`{ (locales?: string \| string[] \| undefined): string; (locales?: LocalesArgument): string; }`
`trim`	`() => string`
`length`	`number`
`substr`	`(from: number, length?: number \| undefined) => string`
`valueOf`	`() => string`
`codePointAt`	`(pos: number) => number \| undefined`
`includes`	`(searchString: string, position?: number \| undefined) => boolean`
`endsWith`	`(searchString: string, endPosition?: number \| undefined) => boolean`
`normalize`	`{ (form: "NFC" \| "NFD" \| "NFKC" \| "NFKD"): string; (form?: string \| undefined): string; }`
`repeat`	`(count: number) => string`
`startsWith`	`(searchString: string, position?: number \| undefined) => boolean`
`anchor`	`(name: string) => string`
`big`	`() => string`
`blink`	`() => string`
`bold`	`() => string`
`fixed`	`() => string`
`fontcolor`	`(color: string) => string`
`fontsize`	`{ (size: number): string; (size: string): string; }`
`italics`	`() => string`
`link`	`(url: string) => string`
`small`	`() => string`
`strike`	`() => string`
`sub`	`() => string`
`sup`	`() => string`
`padStart`	`(maxLength: number, fillString?: string \| undefined) => string`
`padEnd`	`(maxLength: number, fillString?: string \| undefined) => string`
`trimEnd`	`() => string`
`trimStart`	`() => string`
`trimLeft`	`() => string`
`trimRight`	`() => string`
`matchAll`	`(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>`
`replaceAll`	`{ (searchValue: string \| RegExp, replaceValue: string): string; (searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string): string; }`
`at`	`(index: number) => string \| undefined`
`__@iterator@6565`	`() => StringIterator<string>`

`CheckSettings`

The organisation’s settings: JSON, from a host endpoint. Patterns stay in the profiles; settings only add to their lists and tune the scoring.

Name	Type	Default
`commonTerms`	`Partial<Record<CheckLanguage, string[]>>` Extra common terms per language.
`shortForms`	`string[]` Extra short forms, every language.
`weights`	`Partial<Record<CheckLanguage, Partial<SignalWeights>>>` Weight overrides per language.
`thresholds`	`{ recommend?: number; possible?: number; }`
`rules`	`Partial<Record<CheckRuleId, boolean>>` Rules switched on or off. Default: every rule on except CHK-5.

`ResolvedCheckSettings`

Settings merged onto the built-in profiles: what the engine runs on.

Name	Type	Default
`profiles`	`Record<CheckLanguage, LanguageProfile>`
`weights`	`Record<CheckLanguage, SignalWeights>`
`thresholds`	`{ recommend: number; possible: number; }`
`rules`	`Record<CheckRuleId, boolean>`

`LanguageProfile`

Everything language-specific. A seventh language is a new profile, not a refactor. Patterns are code; the organisation’s additions (common terms, short forms, weights) come through CheckSettings.

Name	Type	Default
`language`	`CheckLanguage`
`validated`	`boolean` Measured against labelled documents in Phase 0. The others ship unvalidated.
`stopwords`	`readonly string[]` Frequent function words: the per-block language guess counts them.
`quotes`	`string` Opening quote characters of the language’s preferred style.
`verbs`	`RegExp` A definition verb right after the term: “means”, “désigne”, “bedeutet”.
`includes`	`RegExp` The “includes” verbs among verbs : a lower-case term they introduce (“a “person” includes …”) is the construction clause widening an ordinary word, not a defined term.
`lead`	`RegExp` A word right before the term that makes it a definition (“onder X wordt verstaan”).
`hereinafter`	`RegExp` Inside a parenthesis before the term: “(hereinafter “X”)”.
`referredAs`	`RegExp` The strong subset of hereinafter , trusted outside a parenthesis too.
`mention`	`RegExp` Talking about a term, not defining it: “the definition of “X””.
`conjunctions`	`string` Joins the terms of a grouped entry: “A, B en C: …”.
`copula`	`RegExp` “Vertragsgegenstände sind …”: a definition verb only at a block start.
`parenWords`	`ReadonlySet<string>` Words that may sit in a parenthesis around a term with nothing else: “(the “X”)”.
`articles`	`ReadonlySet<string>`
`connectors`	`string` Lowercase words allowed inside a capitalised phrase (“Board of Directors”).
`common`	`ReadonlySet<string>` Capitalised words that need no definition.
`shortForms`	`ReadonlySet<string>` Abbreviations that need no definition.
`typedRefs`	`RegExp` Typed references (“Clause 4”, “Anlage 2”): never terms.
`genitive`	`string` Connectors that join two terms into a phrase: “Processing of the Personal Data”.
`forward`	`RegExp` After a use, says its definition comes later: “as defined below” (CHK-6).
`definedIn`	`readonly { phrase: RegExp; closing?: RegExp; }[]` Says a term is defined in a clause (CHK-36): “as defined in”, “has the meaning given to it in”, “au sens de l’article”. Global; the reference must start where `phrase` ends, and `closing`, when set, must follow it (“wie in Ziffer 3 definiert”).
`capitalisedNouns`	`boolean` Every noun is capitalised (German): capitals do not mark a term, so “used not defined” (CHK-1) has no signal and stays off.
`placeholders`	`RegExp \| null` This language’s own blanks (“[à compléter]”, “PM”), beside the shared list (CHK-40).
`quotePairs`	`readonly string[]` Each quotation style as its opening and closing mark: ”“””, ”«»” (CHK-41).
`numbers`	`{ locale: string; decimal: "." \| ","; words: Readonly<Record<string, number>>; }` Reading “ten (10)” (CHK-42).
`forms`	`(term: string) => string[]` The surface forms a usage of `term` may take: plurals, possessives, declensions.

`SignalWeights`

Name	Type	Default
`markup`	`number`
`long`	`number`
`quoted`	`number`
`quotePreferred`	`number`
`bold`	`number`
`boldOnce`	`number`
`verb`	`number`
`lead`	`number`
`hereinafter`	`number`
`paren`	`number`
`articleParen`	`number`
`sep`	`number`
`blockStart`	`number`
`run`	`number`
`caps`	`number`
`numbered`	`number`
`cellTerm`	`number`
`allCaps`	`number`
`sentence`	`number`
`lowercase`	`number`
`emptyBody`	`number`
`mention`	`number`
`reference`	`number`
`runIn`	`number`
`capBody`	`number`
`wholeBold`	`number`