Interface: ScheduleCreationOptions

Defined in: src/interfaces.ts:1494

Schedule creation options — user-facing input for TemporalScheduleService.createSchedule. spec and action are typed against the Temporal SDK directly. searchAttributes and catchupWindow are intentionally loose for backward compatibility.

Properties

action

action: ScheduleAction

Defined in: src/interfaces.ts:1497

---

catchupWindow?

optional catchupWindow?: string | number

Defined in: src/interfaces.ts:1507

---

description?

optional description?: string

Defined in: src/interfaces.ts:1510

Informative message — forwarded to Temporal's state.note.

---

limitedActions?

optional limitedActions?: number

Defined in: src/interfaces.ts:1516

Limit on number of actions.

Deprecated

Was not applied in prior releases; continues to be a no-op for backward compatibility. Set state.remainingActions via the SDK directly if you need this behavior.

---

memo?

optional memo?: Record<string, unknown>

Defined in: src/interfaces.ts:1498

---

overlapPolicy?

optional overlapPolicy?: OverlapPolicy

Defined in: src/interfaces.ts:1506

---

paused?

optional paused?: boolean

Defined in: src/interfaces.ts:1505

---

pauseOnFailure?

optional pauseOnFailure?: boolean

Defined in: src/interfaces.ts:1508

---

scheduleId

scheduleId: string

Defined in: src/interfaces.ts:1495

---

searchAttributes?

optional searchAttributes?: Record<string, unknown>

Defined in: src/interfaces.ts:1504

Search attributes. Values are arrays of string/number/Date/boolean (matches Temporal's legacy SearchAttributes shape). Typed loosely here for backward compatibility.

---

spec

spec: ScheduleSpec

Defined in: src/interfaces.ts:1496