Skip to content

js-bao-wss-client


js-bao-wss-client / FunctionInvokeOptions

Interface: FunctionInvokeOptions<TInput> ​

What to send with an invocation. Every field is optional — a function that takes no input is called with no options at all.

Type Parameters ​

TInput ​

TInput = unknown

Properties ​

contextDocId? ​

optional contextDocId?: string


input? ​

optional input?: TInput

The value the handler receives as its input.


meta? ​

optional meta?: Record<string, unknown>

Caller metadata, at most 1 KB encoded.


timeoutMs? ​

optional timeoutMs?: number

Wall-clock budget in milliseconds. Defaults to 5 000 and clamps silently to the platform ceiling of 30 000 — asking for more is not an error, it is asking for something the platform does not offer.

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30