Interface SettingsSchemaEntry<T>

Schema for a single setting declared by a mixin's static settings field. See docs/subsystems/shell-environment.md.

interface SettingsSchemaEntry<T = unknown> {
    default: T;
    description: string;
    enumValues?: T[];
    key: string;
    lifetime?: "persistent" | "session";
    private?: boolean;
    type: SettingType;
    validator?: (value: T) => string | true;
}

Properties

default: T

description: string

enumValues?: T[]

Required when type === 'enum'.

key: string

Dotted-name convention: <sourceMixinDomain>.<sub>...

lifetime?: "persistent" | "session"

Default 'persistent'.

private?: boolean

Default false. Private writes require actor === target.

validator?: (value: T) => string | true

Returns true on success, an error message string on failure.