live_state v0.8.2

LiveState.Event (live_state v0.8.2)

Link to this section Summary

Types

t()

Represents a CustomEvent to be returned from a reply and dispatched on the client.

Link to this section Types

Link to this type

t()

@type t() :: %LiveState.Event{detail: map(), name: String.t()}

Represents a CustomEvent to be returned from a reply and dispatched on the client.

Fields:

  • name: becomes the name of the CustomEvent to be dispatched
  • detail: becomes the detail property (payload) of the CustomEvent. Not that because events will be serialized as JSON, everything here must implement Jason.Encoder