OnePiece.Commanded.Aggregate behaviour (OnePiece.Commanded v0.4.1) View Source

Defines the an OnePiece.Commanded.Aggregate behaviour.

Link to this section Summary

Types

event()

t()

Callbacks

apply(aggregate, event)

Apply a given event to the aggregate returning the new aggregate state.

Functions

__using__(opts \\ [])

Convert the module into a Aggregate behaviour.

Link to this section Types

event()

Specs

event() :: struct()

t()

Specs

t() :: struct()

Link to this section Callbacks

apply(aggregate, event)

Specs

apply(aggregate :: t(), event :: event()) :: t()

Apply a given event to the aggregate returning the new aggregate state.

Example

def apply(account, event) do
  account
  |> Map.put(:name, event.name)
  |> Map.put(:description, event.description)
end

Link to this section Functions

using(opts \\ [])

(macro)

Specs

__using__(opts :: []) :: any()

Convert the module into a Aggregate behaviour.

Usage

defmodule Account do
  use OnePiece.Commanded.Aggregate

  @impl OnePiece.Commanded.Aggregate
  def apply(account, event) do
    account
    |> Map.put(:name, event.name)
    |> Map.put(:description, event.description)
  end
end