pagantis_elixir_tools v0.22.0 ElixirTools.Events.Event

A structure for working with events. event_id_seed is used for event_id generation(UUID5) together with name & version. So if all values are the same event will be updated.

Link to this section Summary

Types

t()

Functions

publish(event, schema, opts \\ [])

publish_deprecated(event, opts \\ [])

validate(event)

validate_json_schema(event, schema)

Link to this section Types

t()

Specs

t() :: %ElixirTools.Events.Event{
  event_id_seed: Ecto.UUID.t(),
  event_id_seed_optional: String.t(),
  name: String.t(),
  occurred_at: DateTime.t() | nil,
  payload: map(),
  version: String.t()
}

Link to this section Functions

publish(event, schema, opts \\ [])

Specs

publish(t(), event_schema(), [publish_opts()]) :: return()

publish_deprecated(event, opts \\ [])

Specs

publish_deprecated(t(), [publish_opts()]) :: return()

validate(event)

Specs

validate(t()) :: return()

validate_json_schema(event, schema)

Specs

validate_json_schema(map(), event_schema()) :: return()