context.resolveCitation
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.
Returns the stable first-seen citation number for one key in AST mode. It mutates citation state; use it while rendering a citation, not to test whether a key exists.
Signature
ts
context.resolveCitation(key: string): numberReturns
A one-based citation number. First use records the key; repeated use returns the existing number.
Call relationships
- Delegates to: the same renderer citation state as legacy
resolveCitation. - Updates:
context.getCitedKeys. - Usually called by: citation helpers rather than ordinary rules.
ts
const number = context.resolveCitation('smith2024');