Interface: BroadcastsModelEventsOptions<M>

Type Parameters

M

optional events?: ModelBroadcastEventName[]

Which lifecycle events to broadcast. Default: created, updated, deleted.

channels: (model, event) => string | string[]

The channel(s) to broadcast on for a given model instance + event.

M

string | string[]

optional as?: (modelName, event) => string

The wire event name. Default: ${ModelName}${Event}, e.g. OrderUpdated.

string

string

optional with?: (model, event) => object

The wire payload. Default: { [camelModelName]: model }, e.g. { order }.

M

object