WatchEntityEventsParameters

WatchEntityEventsParameters = object

Defined in: src/actions/public/watchEntityEvents.ts:32

Handlers and options for client.watchEntityEvents. Every handler is optional; the watcher does the work for the ones you pass.

Properties

fromBlock?

optional fromBlock: bigint

Defined in: src/actions/public/watchEntityEvents.ts:54

Replay from this block before following the head. Defaults to the head.

onEntityCreated()?

optional onEntityCreated: (event) => void

Defined in: src/actions/public/watchEntityEvents.ts:33

Parameters

event

EntityCreatedEvent

Returns

void

onEntityDeleted()?

optional onEntityDeleted: (event) => void

Defined in: src/actions/public/watchEntityEvents.ts:37

Parameters

event

EntityDeletedEvent

Returns

void

onEntityPatched()?

optional onEntityPatched: (event) => void

Defined in: src/actions/public/watchEntityEvents.ts:34

Parameters

event

EntityPatchedEvent

Returns

void

onError()?

optional onError: (error) => void

Defined in: src/actions/public/watchEntityEvents.ts:52

Transport failures, logs that will not decode, and anything one of your own handlers throws.

Defaults to console.error. A watcher whose filter the node dropped otherwise just goes quiet, and a quiet watcher is indistinguishable from a quiet chain.

Parameters

error

Error

Returns

void

onEvent()?

optional onEvent: (event) => void

Defined in: src/actions/public/watchEntityEvents.ts:45

Every event, in application order, whatever its type. Runs before the per-event handler for the same event.

This is the replay seam: operations apply in batch order and emit one event each, so an off-chain replica that consumes this in order sees exactly what the engine did.