Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add example with arguments to `each_iteration #221

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,24 @@ class CsvJob < ApplicationJob
end
```

```ruby
class AdditionalArgumentsJob < ApplicationJob
include JobIteration::Iteration

def build_enumerator(message, name, age, cursor:)
enumerator_builder.active_record_on_records(
User.where(name: name, age: age),
cursor: cursor,
)
end

# addtional arguments as in #build_enumerator (except the cursor)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo here

def each_iteration(user, message, *)
user.notify_about_something(message)
end
end
```

Iteration hooks into Sidekiq and Resque out of the box to support graceful interruption. No extra configuration is required.

## Guides
Expand Down