vigiles API reference
    Preparing search index...

    Interface SettingsCodec

    ⚠️ SettingsCodec was in the same position and is exported here for the same reason: PluginLayout.settings has been typed as one since the codec landed, and the authoring barrel never re-exported it, so docs/adapter-api.md documents a field whose type a third party could not name. One line, and the alternative is a port that cannot be implemented from outside.

    interface SettingsCodec {
        label: string;
        parse(text: string): Record<string, unknown>;
        render(value: Record<string, unknown>): string;
    }
    Index

    Properties

    Methods

    Properties

    label: string

    For messages and the generated JSON Schema only. The core never branches on it — that is the whole reason this is a codec and not an enum, so a branch on this field would put the defect straight back.

    Methods

    • Throws on malformed text; every caller today already catches.

      Parameters

      • text: string

      Returns Record<string, unknown>

    • The inverse, with the trailing newline the harness's own tooling writes.

      Parameters

      • value: Record<string, unknown>

      Returns string