Options passed to a modifier's process or processRaw function.

Hierarchy

  • ModifierOptions

Properties

Properties

invocation: string

The exact text that was entered in the modifier, without the square brackets surrounding it.

state: Record<string, unknown>

This is for the modifier's own use, and the same value is passed to all invocations of a modifier in a single passage. The first time a modifier is invoked, state will be {}. Modifiers must modify this object in-place by assigning properties to it. Reassigning this variable will not pass the new value to the next invocation.

Generated using TypeDoc