1
0
Fork 0
mirror of https://github.com/endofunky/sidetiq.git synced 2022-11-09 13:53:30 -05:00

Add documention for Sidetiq::Schedulable.

This commit is contained in:
Tobias Svensson 2013-02-04 12:11:46 +00:00
parent 877a12a7dd
commit 155ee50bc5

View file

@ -1,7 +1,18 @@
module Sidetiq
# Public: Mixin for Sidekiq::Worker classes.
#
# Examples
#
# class MyWorker
# include Sidekiq::Worker
# include Sidetiq::Schedulable
#
# # Daily at midnight
# tiq { daily }
# end
module Schedulable
module ClassMethods
def tiq(&block)
def tiq(&block) # :nodoc:
clock = Sidetiq::Clock.instance
clock.synchronize do
clock.schedule_for(self).instance_eval(&block)
@ -9,7 +20,7 @@ module Sidetiq
end
end
def self.included(klass)
def self.included(klass) # :nodoc:
klass.extend(Sidetiq::Schedulable::ClassMethods)
end
end