Skip to content

skipLatexWhitespace ​

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.

Advances an index across LaTeX whitespace and complete % line comments. It is a source-reader primitive, not a document cleanup pass.

Signature ​

ts
function skipLatexWhitespace(text: string, index: number): number

Parameters ​

ParameterDescription
textSource being read
indexStarting offset

Returns ​

The first offset that is neither whitespace nor a line comment, or text.length when no token remains.

Call relationships ​

ts
const tokenStart = skipLatexWhitespace(source, commandEnd);

Escaped percent signs are not a supported starting comment token for this reader because it only enters comment skipping when the current character itself is %.

See also ​

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