context.getCitedKeys
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 citation keys currently registered during AST rendering. Use it for bibliography output after citation rules have populated the shared state.
Signature
ts
context.getCitedKeys(): readonly string[]Returns
A new read-only array snapshot in first-seen order, read from the same renderer citation state used by legacy rules.
Call relationships
- Reads state written by:
context.resolveCitationandcontext.renderCitation. - Called by: AST bibliography rules.
- Does not: sort or mutate renderer citation state.
ts
const keys = context.getCitedKeys();Call the method again after registering more citations; an earlier snapshot does not update in place.