Class: UnknownParamError¶

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

Error thrown when an unknown parameter is provided to a template.

Example¶

// Parent defines: projectName: string
// Child uses: @inherit ./parent(projectName: "app", unknownParam: "foo")

Extends¶

PSError

Constructors¶

Constructor¶

new UnknownParamError(paramName, templatePath, availableParams, options?): UnknownParamError

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

Parameters¶

paramName¶

string

templatePath¶

string

availableParams¶

string[]

options?¶

location?¶

SourceLocation

Returns¶

UnknownParamError

Overrides¶

PSError.constructor

Properties¶

availableParams¶

readonly availableParams: string[]

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

Available parameter names

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

paramName¶

readonly paramName: string

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

Name of the unknown parameter

templatePath¶

readonly templatePath: string

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

Path of the template file

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