@pumpkin-plugins/config API / fields / BaseOptions

Interface: BaseOptions<T>

Defined in: tools/config/src/fields.ts:34

Options shared by the config field builders.

Type Parameters

T

T

Properties

default?

optional default?: T

Defined in: tools/config/src/fields.ts:38

Value used when the setting is absent. Leave out to make the setting optional.

---

description

description: string

Defined in: tools/config/src/fields.ts:36

What the setting does.

---

example?

optional example?: T

Defined in: tools/config/src/fields.ts:40

Example value for the commented hint of an optional setting.

---

migrateFrom?

optional migrateFrom?: readonly string[]

Defined in: tools/config/src/fields.ts:42

Path to an older setting whose value should seed this setting when it is absent.