@usine/config/file

Classes

ConfigFileError

A failure pinned to one authored file and one parse stage, so the UI can quarantine that file alone.

Extends

• Schema.Class

Constructors

Constructor

new ConfigFileError(…args): ConfigFileError

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

ConfigFileError

Properties

expression

readonly expression: Option<string & Brand<"ExpressionSource">>

file

readonly file: string & Brand<"InstancePath">

message

readonly message: string

stage

readonly stage: "expression" | "frontmatter" | "read" | "reference" | "schema" | "yaml"

---

FactoryConfigError

The registry or settings could not be loaded, which blocks the whole instance.

Extends

• Schema.Class

Constructors

Constructor

new FactoryConfigError(…args): FactoryConfigError

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

FactoryConfigError

Properties

file

readonly file: string & Brand<"InstancePath">

message

readonly message: string

stage

readonly stage: "expression" | "frontmatter" | "read" | "reference" | "schema" | "yaml"

Type Aliases

ConfigError

ConfigError = typeof ConfigError.Type

---

FileStage

FileStage = typeof FileStage.Type

---

InstancePath

InstancePath = typeof InstancePath.Type

Path of one authored file, relative to the instance folder.

Variables

ConfigError

const ConfigError: Schema.Union<readonly [typeof ConfigFileError, typeof FactoryConfigError]>

---

FileStage

const FileStage: Schema.Literals<readonly ["expression", "frontmatter", "read", "reference", "schema", "yaml"]>

---

InstancePath

const InstancePath: Schema.brand<Schema.NonEmptyString, "InstancePath">

Path of one authored file, relative to the instance folder.