OnePiece.Commanded v0.10.0

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

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

Link to this type

event()

View Source 
@type event() :: struct()
Link to this type

t()

View Source 
@type t() :: struct()

Link to this section Callbacks

Link to this callback

apply(aggregate, event)

View Source 
@callback apply(aggregate :: t(), event :: event()) :: t()

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

example

 Example 

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

Link to this section Functions

Link to this macro

__using__(opts \\ [])

View Source (macro) 
@spec __using__(opts :: []) :: any()

Convert the module into a Aggregate behaviour.

usage

 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