Class: AskBooleanField
Defined in: packages/core/src/core/elicitation/types.ts:138
Boolean field descriptor — ask.boolean('Confirm').default(true)
Extends
AskField<boolean>
Constructors
Constructor
ts
new AskBooleanField(description): AskBooleanField;Defined in: packages/core/src/core/elicitation/types.ts:51
Parameters
| Parameter | Type |
|---|---|
description | string | undefined |
Returns
AskBooleanField
Inherited from
ts
AskField<boolean>.constructorProperties
__type
ts
readonly __type: boolean;Defined in: packages/core/src/core/elicitation/types.ts:44
Phantom brand for type inference — never accessed at runtime
Inherited from
Methods
default()
ts
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 | boolean | Default value shown pre-filled in the client form |
Returns
this
this for chaining
Inherited from
describe()
ts
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