Interface PromptVariable

Variable definition for prompt templates

Defines the type, requirements, and validation for template variables.

Example

const variable: PromptVariable = {
  name: 'userName',
  type: 'string',
  required: true,
  description: 'Name of the user',
  validator: (value) => typeof value === 'string' && value.length > 0
};
interface PromptVariable {
    name: string;
    type: "string" | "number" | "boolean" | "object" | "array";
    required: boolean;
    default?: unknown;
    description?: string;
    validator?: (value: unknown) => boolean;
}

Properties

name type required default? description? validator?

Properties

Readonlyname

name: string

Variable name used in template

Readonlytype

type: "string" | "number" | "boolean" | "object" | "array"

Expected type of the variable

Readonlyrequired

required: boolean

Whether variable is required for rendering

Optional Readonlydefault

default?: unknown

Default value if not provided

Optional Readonlydescription

description?: string

Human-readable description

Optional Readonlyvalidator

validator?: (value: unknown) => boolean

Custom validation function

Settings

Member Visibility

On This Page

Properties