Interface: OptionsDef<Options>

Defined in: plugin-sdk/src/options.ts:9

Declares a plugin's options: a zod (or zod-like) schema for the complete options object and the defaults it starts from. configure(partial) merges shallowly over the current options and re-validates the result, so a host can override one key without repeating the rest.

Type Parameters

Options

Options

Properties

defaults

defaults: Options

Defined in: plugin-sdk/src/options.ts:11

---

describe?

optional describe?: Partial<Record<keyof Options & string, string>>

Defined in: plugin-sdk/src/options.ts:16

Human descriptions per top-level key, used by the docs generator next to the schema-derived type and default.

---

schema

schema: OptionsSchema<Options>

Defined in: plugin-sdk/src/options.ts:10