Class Prose

A compiled Liquid prose template. Created via Prose.parse; the private constructor enforces that path so callers can't hand us an arbitrary AST.

Index

Methods

render toString parse registerFilter

Methods

render

render(vars: Record<string, unknown>): Mml
Render against a variable bag. Mml fragments interpolate verbatim; raw strings are escaped. Result is a finished Mml fragment.
Parameters
- vars: Record<string, unknown>
Returns Mml
- Defined in packages/server/src/mud/lib/prose/Prose.ts:182

toString

toString(): string
The original template source.

Returns string
- Defined in packages/server/src/mud/lib/prose/Prose.ts:188

`Static`parse

parse(source: string): Prose
Compile a template once for repeated rendering.
Parameters
- source: string
Returns Prose
- Defined in packages/server/src/mud/lib/prose/Prose.ts:163

`Static`registerFilter

registerFilter(name: string, fn: FilterFn): void
Register a custom filter on the shared prose engine, usable as {{ x | name }} (with optional args: {{ x | name: 'arg' }}). Filters that return Mml fragments compose with the Mml-aware output handler; raw-string returns get five-entity escaping. Exposed to authors through ProseApi.registerFilter.
Parameters
- name: string
- fn: FilterFn
Returns void
- Defined in packages/server/src/mud/lib/prose/Prose.ts:174