Skip to main content

ReceiverOptions

@rotorsoft/act-root

@rotorsoft/act-root / act-ops/src/receiver / ReceiverOptions

Type Alias: ReceiverOptions

ReceiverOptions = object

Defined in: libs/act-ops/src/receiver/port.ts:105

Options for HTTP Receiver adapters. Transport-specific adapters (bus consumers, WebSocket subscribers) define their own options types — only the Receiver port and the ReceiverBuilder contract stay the same across transports.

Properties​

port​

readonly port: number

Defined in: libs/act-ops/src/receiver/port.ts:110

Port to bind when calling Receiver.listen. Ignored when the receiver is used in fetch-style mode (Lambda / edge).

secret?​

readonly optional secret?: string

Defined in: libs/act-ops/src/receiver/port.ts:129

HMAC-SHA256 shared secret. When set, the HTTP adapter verifies the X-Webhook-Signature and X-Webhook-Timestamp headers against the raw request body. Pair with webhook({ secret }) on the sender side. When undefined, signature verification is skipped.

Transport-specific adapters interpret this field according to their own authentication model.

store​

readonly store: IdempotencyStore

Defined in: libs/act-ops/src/receiver/port.ts:118

Idempotency store the receiver claims keys on. Match the sender's retry envelope when sizing. InMemoryIdempotencyStore from @rotorsoft/act-ops/idempotency is the default single-process choice.