Interface: InputField

Defined in: src/tools/inputRequest.ts:16

Properties

description?

readonly optional description?: string

Defined in: src/tools/inputRequest.ts:20

---

enum?

readonly optional enum?: readonly InputValue[]

Defined in: src/tools/inputRequest.ts:21

---

format?

readonly optional format?: TimeFormat

Defined in: src/tools/inputRequest.ts:33

A TIME field (time design § 6.1): the library checks the answer before the app sees it. 'instant' — an ISO 8601 date-time with its offset (2026-10-09T08:00-07:00); 'time-range' — an ISO 8601 interval from/to of two such instants, from before to; 'zone' — an IANA zone name. The value stays a string on the wire, so refused unless type: 'string'. An answer that fails the check is not taken: the resume door asks again with refused: { answer, reason } (the reason a catalog sentence, defaultTimeAskMessages) and repeat: { count }, and nothing runs. A choice or a supplied value that fails it is refused at definition.

---

id

readonly id: string

Defined in: src/tools/inputRequest.ts:17

---

labels?

readonly optional labels?: readonly string[]

Defined in: src/tools/inputRequest.ts:39

One label per enum choice, in its order — what a person reads beside the value ('Fri, Oct 9, 2026, 8:00 – 8:40 AM PDT'); the value is what the answer carries. Needs enum.

---

required?

readonly optional required?: boolean

Defined in: src/tools/inputRequest.ts:19

---

strict?

readonly optional strict?: boolean

Defined in: src/tools/inputRequest.ts:45

A time field's choices are the only answers. Without it a format field with enum keeps free entry open: any answer the format check takes is taken. Needs format and enum.

---

type

readonly type: "string" | "number" | "boolean"

Defined in: src/tools/inputRequest.ts:18