@pumpkin-plugins/config API / fields / StringCheck

Interface: StringCheck

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

Extra rules for a string setting.

Properties

expected

expected: string

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

What a valid value looks like, used in warnings.

---

normalize?

optional normalize?: (value) => string

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

Tidies an accepted value, for example by trimming a trailing slash.

Parameters

value

string

Returns

string

---

test

test: (value) => boolean

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

Whether a value is acceptable.

Parameters

value

string

Returns

boolean