SettingDefinition

Defined in: core.ts:448

Declares a user-configurable setting in the plugin manifest.

The host validates values against type, enum membership, and numeric min/max constraints before persisting.

Properties

key

key: string

Defined in: core.ts:450

Setting key used in settings.get() / settings.set().

---

label

label: string

Defined in: core.ts:452

Human-readable label shown in the settings UI.

---

type

type: "string" | "number" | "bool" | "enum"

Defined in: core.ts:454

Value type: bool, number, enum (pick from options), or string.

---

default?

optional default?: unknown

Defined in: core.ts:456

Default value when no user preference is stored.

---

options?

optional options?: unknown[]

Defined in: core.ts:458

Valid options for “enum” type settings.

---

min?

optional min?: number

Defined in: core.ts:460

Minimum value for “number” type settings.

---

max?

optional max?: number

Defined in: core.ts:462

Maximum value for “number” type settings.