PreviewUpdateService.getDiagnostics
How to read this API
These are TypeScript APIs compiled into SnapTeX; a .tex project cannot load them at runtime.
function name(...)is a helper that your rule imports and calls.apply(...),render(...),extract(...), andcollect(...)are callbacks that your rule implements and SnapTeX calls.renderer.name(...),context.name(...),input.name(...), anddeps.name(...)are methods SnapTeX supplies to callbacks; do not import or construct them.service.name(...)is an instance method called after your host or test constructsPreviewUpdateService.
Register extension declarations through SNAP_TEX_RULES in src/rules.ts. See Source API Scope for imports, value ownership, output safety, rebuilds, and testing.
Reads diagnostics from the most recent document parse.
Signature
ts
service.getDiagnostics(): readonly DocumentDiagnostic[]Returns
A read-only view of the diagnostics stored by the latest render call. resetState clears the list.
Call relationships
- State written by:
LatexDocument.parseinsiderender. - Called by: hosts that surface parse warnings or tests that assert recovery behavior.