js-bao-wss-client

---

js-bao-wss-client / FunctionStartOptions

Interface: FunctionStartOptions<TInput>

What to send with a task start.

Type Parameters

TInput

TInput = unknown

Properties

contextDocId?

optional contextDocId?: string

---

input?

optional input?: TInput

The value the handler receives as its input (travels as rootInput).

---

meta?

optional meta?: Record<string, unknown>

Caller metadata, at most 1 KB encoded.

---

runKey?

optional runKey?: string

Idempotency key, scoped to (caller, contextDocId). A repeated value replays the run that already exists rather than starting a second one. Defaults to the run id.