js-bao-wss-client

---

js-bao-wss-client / CreateCronTriggerParams

Interface: CreateCronTriggerParams<I>

I is an optional additive generic typing the write-side rootInput payload. It defaults to today's untyped any, so existing callers are unaffected. Note the asymmetry: CronTriggerInfo.rootInput (the return shape) stays string | null because the server serializes it — I types only the object you write here.

Type Parameters

I

I = unknown

Properties

cron

cron: string

Standard 5-field cron expression.

---

description?

optional description?: string

Optional human-readable description.

---

displayName

displayName: string

Display name shown in UIs.

---

inputMapping?

optional inputMapping?: any

Additional mapped inputs; supports {{now}} template substitution.

---

overlapPolicy?

optional overlapPolicy?: "skip" | "allow"

What happens when a cron tick arrives while a prior run is still active. Default: "skip".

---

rootInput?

optional rootInput?: I

Root input passed to the workflow on each fire.

---

timezone?

optional timezone?: string

IANA timezone (e.g. "America/New_York"). Defaults to "UTC".

---

triggerKey

triggerKey: string

Unique per-app identifier (alphanumerics, hyphens, underscores).

---

workflowKey

workflowKey: string

Workflow key to invoke when the cron fires.