doc/SidekiqUniqueJobs/Job.html
<!DOCTYPE html><html> <head> <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title> Module: SidekiqUniqueJobs::JobUnexpected trailing spaces found. — Documentation by YARD 0.9.26Unexpected trailing spaces found. </title> <link rel="stylesheet" href="../css/style.css" type="text/css" /> <link rel="stylesheet" href="../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "SidekiqUniqueJobs::Job"; relpath = '../';</script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu">Unexpected trailing spaces found. <a href="../_index.html">Index (J)</a> » <span class='title'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span>Expected an indentation at 6 instead of at 5.
Unexpected trailing spaces found. » <span class="title">Job</span>Unexpected trailing spaces found. </div> <div id="search">Unexpected trailing spaces found. <a class="full_list_link" id="class_list_link" href="../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a>Unexpected trailing spaces found. </div> <div class="clear"></div> </div> <div id="content"><h1>Module: SidekiqUniqueJobs::JobUnexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h1><div class="box_info">Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <dl> <dt>Extended by:</dt> <dd><span class='object_link'><a href="" title="SidekiqUniqueJobs::Job (module)">Job</a></span></dd> </dl>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <dl> <dt>Included in:</dt> <dd><span class='object_link'><a href="" title="SidekiqUniqueJobs::Job (module)">Job</a></span></dd> </dl>Unexpected trailing spaces found. Unexpected trailing spaces found. <dl> <dt>Defined in:</dt> <dd>lib/sidekiq_unique_jobs/job.rb</dd> </dl>Unexpected trailing spaces found. </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Utility class to append uniqueness to the sidekiq job hash</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Author:</p><ul class="author">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div> Unexpected trailing spaces found. <h2> Class Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary">Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#add_digest-class_method" title="#add_digest (class method)">.<strong>add_digest</strong>(item) ⇒ Hash </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Adds lock_args, lock_prefix and lock_digest to the sidekiq job hash.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#prepare-class_method" title="#prepare (class method)">.<strong>prepare</strong>(item) ⇒ Hash </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Adds timeout, expiration, lock_args, lock_prefix and lock_digest to the sidekiq job hash.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. </ul>Unexpected trailing spaces found. <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary">Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#add_digest-instance_method" title="#add_digest (instance method)">#<strong>add_digest</strong>(item) ⇒ Hash </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Adds lock_args, lock_prefix and lock_digest to the sidekiq job hash.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. <li class="public "> <span class="summary_signature">Unexpected trailing spaces found. <a href="#prepare-instance_method" title="#prepare (instance method)">#<strong>prepare</strong>(item) ⇒ Hash </a>Unexpected trailing spaces found. Unexpected trailing spaces found. </span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. <span class="summary_desc"><div class='inline'><p>Adds timeout, expiration, lock_args, lock_prefix and lock_digest to the sidekiq job hash.</p></div></span>Unexpected trailing spaces found. </li> Unexpected trailing spaces found. </ul>Unexpected trailing spaces found. <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="add_digest-class_method">Unexpected trailing spaces found. Unexpected trailing spaces found. .<strong>add_digest</strong>(item) ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Adds lock_args, lock_prefix and lock_digest to the sidekiq job hash</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the job hash</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21222324252627</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/job.rb', line 21</span> <span class='kw'>def</span> <span class='id identifier rubyid_add_digest'>add_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_prefix'>add_lock_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_args'>add_lock_args</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_digest'>add_lock_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_item'>item</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="prepare-class_method">Unexpected trailing spaces found. Unexpected trailing spaces found. .<strong>prepare</strong>(item) ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Adds timeout, expiration, lock_args, lock_prefix and lock_digest to the sidekiq job hash</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the job hash</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 121314151617</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/job.rb', line 12</span> <span class='kw'>def</span> <span class='id identifier rubyid_prepare'>prepare</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_stringify_on_conflict_hash'>stringify_on_conflict_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_timeout'>add_lock_timeout</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_ttl'>add_lock_ttl</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_digest'>add_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> Unexpected trailing spaces found. <div class="method_details first"> <h3 class="signature first" id="add_digest-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>add_digest</strong>(item) ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Adds lock_args, lock_prefix and lock_digest to the sidekiq job hash</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the job hash</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21222324252627</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/job.rb', line 21</span> <span class='kw'>def</span> <span class='id identifier rubyid_add_digest'>add_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_prefix'>add_lock_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_args'>add_lock_args</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_digest'>add_lock_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_item'>item</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. <div class="method_details "> <h3 class="signature " id="prepare-instance_method">Unexpected trailing spaces found. Unexpected trailing spaces found. #<strong>prepare</strong>(item) ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt> Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. </h3><div class="docstring"> <div class="discussion"> <p>Adds timeout, expiration, lock_args, lock_prefix and lock_digest to the sidekiq job hash</p> </div></div><div class="tags">Unexpected trailing spaces found. <p class="tag_title">Returns:</p><ul class="return">Unexpected trailing spaces found. <li>Unexpected trailing spaces found. Unexpected trailing spaces found. <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>Unexpected trailing spaces found. Unexpected trailing spaces found. Unexpected trailing spaces found. — <div class='inline'><p>the job hash</p></div>Unexpected trailing spaces found. </li>Unexpected trailing spaces found. </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 121314151617</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/job.rb', line 12</span> <span class='kw'>def</span> <span class='id identifier rubyid_prepare'>prepare</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_stringify_on_conflict_hash'>stringify_on_conflict_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_timeout'>add_lock_timeout</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_lock_ttl'>add_lock_ttl</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span> <span class='id identifier rubyid_add_digest'>add_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span><span class='kw'>end</span></pre> </td> </tr></table></div>Unexpected trailing spaces found. </div> </div> <div id="footer"> Generated on Mon Sep 27 15:29:05 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.2).</div> </div> </body>Expected a newline at the end of the file.</html>