PreviewUpdateService.getMacroNames

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(...), and collect(...) are callbacks that your rule implements and SnapTeX calls.
• renderer.name(...), context.name(...), input.name(...), and deps.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 constructs PreviewUpdateService.

Register extension declarations through SNAP_TEX_RULES in src/rules.ts. See Source API Scope for imports, value ownership, output safety, rebuilds, and testing.

Returns macro names known to the current document.

Signature

service.getMacroNames(): string[]

Returns

A new array of keys from document.metadata.macros. The order is not part of the API contract; sort the result at the presentation boundary when needed.

Call relationships

• Reads: metadata state populated by the latest render.
• Called by: host LaTeX completion providers and tests.
• Does not: expose or mutate the macro definitions object.

See also

• getBibliographyKeys
• PreviewUpdateService.render