@pumpkin-plugins/config API / fields / str

Function: str()

A text setting, optionally restricted by a check.

Param

options

Description, optional check and, unless the setting is optional, its default.

Call Signature

str(options): Field<string>

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

A text setting, optionally restricted by a check.

Parameters

options

BaseOptions<string> & object

Returns

Field<string>

Call Signature

str(options): Field<string | undefined>

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

A text setting, optionally restricted by a check.

Parameters

options

BaseOptions<string> & object

Returns

Field<string | undefined>