Interface: TimeOptions

Defined in: src/time/clock.ts:107

The builder's .time(options) — the fallback zone, the reader and its policy (time design § 11).

Properties

messages?

readonly optional messages?: Partial<Readonly<Record<"answer.not-an-instant" | "answer.no-offset" | "answer.not-a-range" | "answer.out-of-order" | "answer.dst-gap" | "answer.not-a-zone" | "answer.time-future" | "answer.time-past" | "answer.beyond-retention" | "answer.over-max-range" | "ask.which" | "ask.confirm" | "ask.zone" | "ask.zone-unknown" | "choice.confirm", string> & Partial<Record<"choice.unconverted" | "reply.correction", string>>>>

Defined in: src/time/clock.ts:136

Your words for the time ask (defaultTimeAskMessages keys → sentence): the reason a refused time answer is re-asked with, the ask's questions, the label on a reading to confirm. A key you leave out keeps the default.

---

policy?

readonly optional policy?: object

Defined in: src/time/clock.ts:127

How the library picks among a reading's candidates (needs reader). dateOrder (default 'ask'): a numeric date's orders become choices, or the one order your people write ('MDY', 'DMY', 'YMD'), recorded as assumed. year (default 'ask'): a date said without a year is asked, or 'current' — the clock's year, recorded as assumed.

dateOrder?

readonly optional dateOrder?: "ask" | "MDY" | "DMY" | "YMD"

year?

readonly optional year?: "ask" | "current"

---

reader?

readonly optional reader?: TimeReader

Defined in: src/time/clock.ts:119

The strategy that reads the person's words into time parts (TimeReader). No default: without one, the person's words are not read — no time-reading row is filed.

---

zone?

readonly optional zone?: string

Defined in: src/time/clock.ts:113

The fallback zone for a run that names none. Omitted with no run zone either: the zone is unknown — never the server's — and the person is asked it before any time they wrote is read (G15).