mhenrixon/sidekiq-unique-jobs

View on GitHub
doc/Sidekiq.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Sidekiq
Unexpected trailing spaces found.
&mdash; Documentation by YARD 0.9.26
Unexpected 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 = "Sidekiq";
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 (S)</a> &raquo;
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class="title">Sidekiq</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: Sidekiq
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class="private note title">Private</span>
</h1>
<div class="box_info">
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.
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/testing.rb<span class="defines">,<br />
lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb</span>
</dd>
</dl>
Unexpected trailing spaces found.
</div>
 
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This module is part of a private API.</strong>
You should avoid using this module if possible, as it may be removed or be changed in the future.
</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
 
</div><h2>Defined Under Namespace</h2>
<p class="children">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Sidekiq/Worker.html" title="Sidekiq::Worker (module)">Worker</a></span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Sidekiq/Job.html" title="Sidekiq::Job (class)">Job</a></span>, <span class='object_link'><a href="Sidekiq/JobRecord.html" title="Sidekiq::JobRecord (class)">JobRecord</a></span>, <span class='object_link'><a href="Sidekiq/JobSet.html" title="Sidekiq::JobSet (class)">JobSet</a></span>, <span class='object_link'><a href="Sidekiq/Queue.html" title="Sidekiq::Queue (class)">Queue</a></span>, <span class='object_link'><a href="Sidekiq/ScheduledSet.html" title="Sidekiq::ScheduledSet (class)">ScheduledSet</a></span>, <span class='object_link'><a href="Sidekiq/SortedEntry.html" title="Sidekiq::SortedEntry (class)">SortedEntry</a></span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</p>
 
 
 
 
 
 
 
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="#use_options-class_method" title="use_options (class method)">.<strong>use_options</strong>(tmp_config = {}) &#x21d2; Object </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>Temporarily turn Sidekiq&#39;s options into something different.</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="use_options-class_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
.<strong>use_options</strong>(tmp_config = {}) &#x21d2; <tt>Object</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
Unexpected trailing spaces found.
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>this method will restore the original options after yielding</p>
</div>
</div>
 
<p>Temporarily turn Sidekiq&#39;s options into something different</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>tmp_config</span>
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>&lt;Symbol, Object&gt;</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<em class="default">(defaults to: <tt>{}</tt>)</em>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the temporary config to use</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
24
25
26
27
28
29
30
31
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/testing.rb', line 24</span>
 
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_use_options'>use_options</span><span class='lparen'>(</span><span class='id identifier rubyid_tmp_config'>tmp_config</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_old_options'>old_options</span> <span class='op'>=</span> <span class='id identifier rubyid_default_worker_options'>default_worker_options</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
 
<span class='id identifier rubyid_default_worker_options'>default_worker_options</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_worker_options'>default_worker_options</span> <span class='op'>=</span> <span class='id identifier rubyid_tmp_config'>tmp_config</span>
<span class='kw'>yield</span>
<span class='kw'>ensure</span>
<span class='id identifier rubyid_default_worker_options'>default_worker_options</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_worker_options'>default_worker_options</span> <span class='op'>=</span> <span class='const'>DEFAULT_WORKER_OPTIONS</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_worker_options'>default_worker_options</span> <span class='op'>=</span> <span class='id identifier rubyid_old_options'>old_options</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>