Class XmlTemplateProcessor

XML block template processor.

Hierarchy (View Summary)

XmlTemplateProcessor
- TextTemplateProcessor

Implements

ITextTemplateProcessor

Index

Constructors

Methods

expand expandDocument expandNodes processBlock processIdentifier

Constructors

constructor

new XmlTemplateProcessor(options?: TextTemplateOptions): XmlTemplateProcessor
Parameters
- options: TextTemplateOptions = {}
Returns XmlTemplateProcessor
- Defined in packages/foundation/src/lib/templating/template-processor.ts:429

Methods

expand

expand(template: string, context: Record<string, unknown>): string
Fully expands an XML template string.
Parameters
- template: string
- context: Record<string, unknown>
Returns string
Implementation of ITextTemplateProcessor.expand
- Defined in packages/foundation/src/lib/templating/template-processor.ts:436

expandDocument

expandDocument(
document: TemplateDocument,
context: Record<string, unknown>,
): string
Fully expands an already parsed template document.
Parameters
- document: TemplateDocument
- context: Record<string, unknown>
Returns string
Implementation of ITextTemplateProcessor.expandDocument
- Defined in packages/foundation/src/lib/templating/template-processor.ts:443

expandNodes

expandNodes(
nodes: readonly TemplateNode[],
context: Record<string, unknown>,
): string
Expands a node collection.
Parameters
- nodes: readonly TemplateNode[]
- context: Record<string, unknown>
Returns string
Implementation of ITextTemplateProcessor.expandNodes
- Defined in packages/foundation/src/lib/templating/template-processor.ts:453

processBlock

processBlock(block: TemplateBlockNode, context: Record<string, unknown>): string
Dispatches one block to its registered provider.
Parameters
- block: TemplateBlockNode
- context: Record<string, unknown>
Returns string
Implementation of ITextTemplateProcessor.processBlock
- Defined in packages/foundation/src/lib/templating/template-processor.ts:463

processIdentifier

processIdentifier(key: string, context: Record<string, unknown>): string
Resolves a context key for built-in replacement blocks.
Parameters
- key: string
- context: Record<string, unknown>
Returns string
Implementation of ITextTemplateProcessor.processIdentifier
- Defined in packages/foundation/src/lib/templating/template-processor.ts:480