@tikoci/centrs
    Preparing search index...

    Interface SettingsKeyDef

    interface SettingsKeyDef {
        attr: string;
        commentKvKey?: string;
        envKey: string;
        hasPerCommandDefault?: boolean;
        parse: (raw: string, envKey: string) => ParsedSetting;
        warn?: (value: SettingsValue) => string | undefined;
    }
    Index

    Properties

    attr commentKvKey? envKey hasPerCommandDefault? parse warn?

    Properties

    attr: string

    Kebab-case CLI-facing name, e.g. "max-results".

    commentKvKey?: string

    Per-device CDB comment-kv counterpart, if one exists (informational only).

    envKey: string

    CENTRS_* env var name.

    hasPerCommandDefault?: boolean

    Only true for format: the built-in default genuinely varies by command.

    parse: (raw: string, envKey: string) => ParsedSetting

    Parse + validate raw input. Throws a settings/invalid-* CentrsError on bad input.

    warn?: (value: SettingsValue) => string | undefined

    A one-line reminder to surface as a warning when set accepts this value.

    Settings

    Member Visibility

    On This Page

    Properties