moderator-toolbox-nxg-for-reddit / util/wiki/schemas/config/validation

validation¶

Functions¶

validateWikiEditorJson()¶

validateWikiEditorJson(text, page): WikiEditorDiagnostic[]

Defined in: extension/data/util/wiki/schemas/config/validation.ts:179

Validates wiki editor text for a JSON page, returning diagnostics with character offsets. Syntax errors yield a single 'error'; schema shape problems yield 'warning's. Returns [] for blank text.

Parameters¶

text¶

string

The current editor text.

page¶

ValidatablePage

Which page’s schema to check against.

Returns¶

WikiEditorDiagnostic[]

Interfaces¶

WikiEditorDiagnostic¶

Defined in: extension/data/util/wiki/schemas/config/validation.ts:18

One validation finding, with character offsets into the editor text.

Properties¶

from¶

from: number

Defined in: extension/data/util/wiki/schemas/config/validation.ts:19

message¶

message: string

Defined in: extension/data/util/wiki/schemas/config/validation.ts:23

severity¶

severity: "error" | "warning"

Defined in: extension/data/util/wiki/schemas/config/validation.ts:22

'error' blocks saving (syntax); 'warning' highlights but saves.

to¶

to: number

Defined in: extension/data/util/wiki/schemas/config/validation.ts:20

Type Aliases¶

ValidatablePage¶

ValidatablePage = "toolbox" | "usernotes" | "usernotesShard"

Defined in: extension/data/util/wiki/schemas/config/validation.ts:27

The wiki editor pages this validator knows the schema of.