Class: AskStringField

Defined in: packages/core/src/core/elicitation/types.ts:87

String field descriptor — ask.string('Name')

Extends

• AskField<string>

Constructors

Constructor

new AskStringField(description): AskStringField;

Defined in: packages/core/src/core/elicitation/types.ts:51

Parameters

Parameter	Type
description	string | undefined

Returns

AskStringField

Inherited from

AskField<string>.constructor

Properties

__type

readonly __type: string;

Defined in: packages/core/src/core/elicitation/types.ts:44

Phantom brand for type inference — never accessed at runtime

Inherited from

AskField.__type

Methods

default()

default(value): this;

Defined in: packages/core/src/core/elicitation/types.ts:61

Set a default value for this field.

Parameters

Parameter	Type	Description
value	string	Default value shown pre-filled in the client form

Returns

this

this for chaining

Inherited from

AskField.default

---

describe()

describe(desc): this;

Defined in: packages/core/src/core/elicitation/types.ts:72

Set or override the field description.

Parameters

Parameter	Type	Description
desc	string	Human-readable label/description

Returns

this

this for chaining

Inherited from

AskField.describe