kotovalexarian-likes-github/aasm
1
0
Fork 0
mirror of https://github.com/aasm/aasm synced 2023-03-27 23:22:41 -04:00
Code Releases Activity

Fix ambiguity in Readme for callback and gaurds params

Browse source
This commit is contained in:
Anil Kumar Maurya 2021-03-16 00:21:16 +05:30 • committed by GitHub
parent 143eedcd65
commit 5856e3a223
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -224,15 +224,15 @@ You can pass parameters to events:
All guards and after callbacks will receive these parameters. In this case `set_process` would be called with
`:defragmentation` argument.
If the first argument to the event is a state (e.g. `:running` or `:finished`), the argument is consumed and
the state machine will attempt to transition to that state. To avoid any ambiguity, we recommend using keyword
args like so:
If the first argument to the event is a state (e.g. `:running` or `:finished`), the first argument is consumed and
the state machine will attempt to transition to that state. Add comma separated parameter for gaurds and callbacks
```ruby
job = Job.new
job.run(process: :defragmentation)
job.run(:running, :defragmentation)
```
In this case `set_process` would be called with the argument `{process: :defragmentation}`
In this case `set_process` won't be called, job will transition to running state and callback will receive
:defragmentation as parameter
#### Error Handeling
In case of an error during the event processing the error is rescued and passed to `:error`