README.adoc in sidekiq-throttled-1.0.0.alpha.1 vs README.adoc in sidekiq-throttled-1.0.0

- old
+ new

@@ -87,10 +87,29 @@ # ... end ---- +=== Configuration + +[source,ruby] +---- +Sidekiq::Throttled.configure do |config| + # Period in seconds to exclude queue from polling in case it returned + # {config.cooldown_threshold} amount of throttled jobs in a row. Set + # this value to `nil` to disable cooldown manager completely. + # Default: 2.0 + config.cooldown_period = 2.0 + + # Exclude queue from polling after it returned given amount of throttled + # jobs in a row. + # Default: 1 (cooldown after first throttled job) + config.cooldown_threshold = 1 +end +---- + + === Observer You can specify an observer that will be called on throttling. To do so pass an `:observer` option with callable object: @@ -230,11 +249,10 @@ == Supported Ruby Versions This library aims to support and is tested against the following Ruby versions: -* Ruby 2.7.x * Ruby 3.0.x * Ruby 3.1.x * Ruby 3.2.x If something doesn't work on one of these versions, it's a bug. @@ -253,12 +271,12 @@ == Supported Sidekiq Versions This library aims to support and work with following Sidekiq versions: -* Sidekiq 6.5.x * Sidekiq 7.0.x * Sidekiq 7.1.x +* Sidekiq 7.2.x == Development bundle install