Class TomlFileError

An error on a TOML file — missing or malformed. Carries path and a clean message suitable for JSON output.

Hierarchy (View Summary)

AbortError
- TomlFileError

Index

Constructors

Properties

code? customSections? details? formattedMessage? nextSteps? path skipOclifErrorHandling tryMessage type

Constructors

constructor

new TomlFileError(path: string, message: string): TomlFileError
Parameters
- path: string
- message: string
Returns TomlFileError
Overrides AbortError.constructor
- Defined in packages/cli-kit/src/public/node/toml/toml-file.ts:15

Properties

`Optional`code

code?: string

A stable code for JSON consumers to identify this error, included only when known.

`Optional`customSections

customSections?: CustomSection[]

`Optional`details

details?: unknown

Selected JSON-serializable data to include in JSON errors. Never attach the raw error or request.

`Optional`formattedMessage

formattedMessage?: TokenItem

`Optional`nextSteps

nextSteps?: TokenItem<InlineToken>[]

`Readonly`path

path: string

skipOclifErrorHandling

skipOclifErrorHandling: boolean

tryMessage

tryMessage: TokenItem | null

type

type: FatalErrorType