Skip to content

@usine/config/instance

One consistent snapshot of an instance folder. Construction fails if a loop references a name the instance does not have.

  • Schema.Class

new LoadedInstance(…args): LoadedInstance

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

LoadedInstance

readonly agents: readonly AgentFile[]

readonly config: UsineConfig

readonly invalidAgents: readonly InvalidAgent[]

readonly loops: readonly LoopFile[]

readonly quarantinedLoops: readonly QuarantinedLoop[]

readonly warnings: readonly (UndeclaredLaneLabelWarning | UndeclaredTriggerLabelWarning)[]


  • Schema.Class

new UndeclaredLaneLabelWarning(…args): UndeclaredLaneLabelWarning

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

UndeclaredLaneLabelWarning

readonly label: string & Brand<"GitHubLabelName">

readonly lane: string & Brand<"LaneName">

readonly repository: string & Brand<"RepositoryName">


  • Schema.Class

new UndeclaredTriggerLabelWarning(…args): UndeclaredTriggerLabelWarning

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

UndeclaredTriggerLabelWarning

readonly label: string & Brand<"GitHubLabelName">

readonly loop: string & Brand<"LoopName">

ConfigWarning = typeof ConfigWarning.Type

Diagnostics that do not block a load.

const ConfigWarning: Schema.Union<readonly [typeof UndeclaredLaneLabelWarning, typeof UndeclaredTriggerLabelWarning]>

Diagnostics that do not block a load.