argumentText

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.

Flattens an AST argument to readable text. Use it for names, keys, and other plain-text arguments; use renderChildren when nested formatting must survive.

Signature

function argumentText(argument: SnaptexAstArgument | undefined): string

Returns

The recursively concatenated text content of argument nodes, or an empty string when the argument is absent. AST whitespace nodes become ordinary spaces.

Call relationships

• Called after: readRequiredMacroArgument or readOptionalMacroArgument.
• Called by: readAstCommandArguments.
• Does not: render nested LaTeX to HTML.

const label = argumentText(readRequiredMacroArgument(node));

Use renderChildren when nested structure and formatting must be preserved.

See also

• renderChildren