Skip to content

PromptScript API


Class: UndefinedVariableError

Defined in: core/src/errors/template.ts:114

Error thrown when a template variable is used but not defined.

Example

// Template has: {{projectName}}
// But projectName was not provided and has no default

Extends

Constructors

Constructor

new UndefinedVariableError(variableName, sourceFile, options?): UndefinedVariableError

Defined in: core/src/errors/template.ts:120

Parameters

variableName

string

sourceFile

string

options?
location?

SourceLocation

Returns

UndefinedVariableError

Overrides

PSError.constructor

Properties

cause?

readonly optional cause: Error

Defined in: core/src/errors/base.ts:43

Original error if wrapping another error

Inherited from

PSError.cause


code

readonly code: string

Defined in: core/src/errors/base.ts:39

Error code

Inherited from

PSError.code


location?

readonly optional location: SourceLocation

Defined in: core/src/errors/base.ts:41

Source location where error occurred

Inherited from

PSError.location


sourceFile

readonly sourceFile: string

Defined in: core/src/errors/template.ts:118

File where the variable was used


variableName

readonly variableName: string

Defined in: core/src/errors/template.ts:116

Name of the undefined variable

Methods

format()

format(): string

Defined in: core/src/errors/base.ts:66

Format error for display.

Returns

string

Inherited from

PSError.format


toJSON()

toJSON(): Record\<string, unknown>

Defined in: core/src/errors/base.ts:79

Convert to JSON-serializable object.

Returns

Record\<string, unknown>

Inherited from

PSError.toJSON