Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fmterrorf committed Sep 18, 2024
1 parent 450ee05 commit fb46ba0
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions lib/commanded/event/handler.ex
Original file line number Diff line number Diff line change
Expand Up @@ -502,17 +502,7 @@ defmodule Commanded.Event.Handler do
Return `:ok` on success. All events in the batch will be acknowledged.
On error, you can either return `{:error, reason}` to indicate something
with the whole batch went wrong, or `{:error, reason, event}` to indicate
that all events prior to this event were processed successfully but this
particular event went wrong.
In both cases, the error handler will be called. When just a reason is
returned, the assumption is that a system issue is preventing the process
from continuing or the entire batch is invalid. In this case, the error
handler will be called with the last event of the batch as the event argument.
When an event and a reason are returned, the assumption is that something is
wrong with the event itself and therefore, it is passed in as the first
argument for the error handler.
with the whole batch went wrong
Note that this interface may change as more experience with use cases
for batching is gained.
Expand Down

0 comments on commit fb46ba0

Please sign in to comment.