Skip to content

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(...), 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 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): number

Returns ​

A one-based citation number. First use records the key; repeated use returns the existing number.

Call relationships ​

ts
const number = context.resolveCitation('smith2024');

See also ​

A fast structural preview, not a replacement for a full TeX compiler.