Class HandlebarsPromptTemplate

Prompt template implementation using Handlebars

Provides variable substitution using Handlebars syntax with:

  • Built-in helpers (if, each, unless, with, etc.)
  • Custom helpers support
  • Partials support
  • Type validation

Example

const template = new HandlebarsPromptTemplate({
  id: 'greeting',
  name: 'Greeting Template',
  version: '1.0.0',
  template: 'Hello {{userName}}! {{#if premium}}You are a premium user.{{/if}}',
  variables: [
    { name: 'userName', type: 'string', required: true },
    { name: 'premium', type: 'boolean', required: false, default: false }
  ],
  helpers: {
    uppercase: (str: string) => str.toUpperCase()
  }
});

const result = template.render({ userName: 'Alice', premium: true });
if (result.isSuccess) {
  console.log(result.value); // "Hello Alice! You are a premium user."
}

Implements

  • PromptTemplate

Constructors

constructor

Methods

render validate clone

Properties

id name version template variables metadata

Constructors

constructor

Methods

render

  • render(variables: Record<string, unknown>): Result<string, Error>

    Render template with provided variables

    Parameters

    • variables: Record<string, unknown>

    Returns Result<string, Error>

validate

  • validate(variables: Record<string, unknown>): PromptValidationResult

    Validate variables before rendering

    Parameters

    • variables: Record<string, unknown>

    Returns PromptValidationResult

clone

Properties

Readonlyid

id: string

Unique identifier for this prompt

Readonlyname

name: string

Human-readable name

Readonlyversion

version: string

Semantic version

Readonlytemplate

template: string

Template string with variable placeholders

Readonlyvariables

variables: PromptVariable[]

Variable definitions

Readonlymetadata

metadata: PromptMetadata

Metadata about this prompt

Settings

Member Visibility

On This Page

Constructors
Methods
Properties