mhenrixon/sidekiq-unique-jobs

View on GitHub
doc/Sidekiq/Worker/Overrides.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::Worker::Overrides
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::Worker::Overrides";
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 (O)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Sidekiq.html" title="Sidekiq (module)">Sidekiq</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Worker.html" title="Sidekiq::Worker (module)">Worker</a></span></span>
Unexpected trailing spaces found.
Expected an indentation at 6 instead of at 5.
&raquo;
<span class="title">Overrides</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::Worker::Overrides
Unexpected 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.
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="../Worker.html" title="Sidekiq::Worker (module)">Sidekiq::Worker</a></span></dd>
</dl>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/testing.rb</dd>
</dl>
Unexpected trailing spaces found.
</div>
 
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Prepends deletion of locks to clear_all</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
 
</div>
 
 
 
 
 
 
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="#clear_all-instance_method" title="#clear_all (instance method)">#<strong>clear_all</strong> &#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>Clears all jobs for this worker and removes all locks.</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="#sidekiq_options-instance_method" title="#sidekiq_options (instance method)">#<strong>sidekiq_options</strong>(options = {}) &#x21d2; void </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>Overrides sidekiq_options on the worker class to prepend validation.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
</ul>
Unexpected trailing spaces found.
 
 
 
<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="clear_all-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>clear_all</strong> &#x21d2; <tt>Object</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Clears all jobs for this worker and removes all locks</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
94
95
96
97
98</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/testing.rb', line 94</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_clear_all'>clear_all</span>
<span class='kw'>super</span>
 
<span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs/Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../SidekiqUniqueJobs/Digests.html#initialize-instance_method" title="SidekiqUniqueJobs::Digests#initialize (method)">new</a></span></span><span class='period'>.</span><span class='id identifier rubyid_delete_by_pattern'><span class='object_link'><a href="../../SidekiqUniqueJobs/Digests.html#delete_by_pattern-instance_method" title="SidekiqUniqueJobs::Digests#delete_by_pattern (method)">delete_by_pattern</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>count:</span> <span class='int'>10_000</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="sidekiq_options-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>sidekiq_options</strong>(options = {}) &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Overrides sidekiq_options on the worker class to prepend validation</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'>options</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></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>worker options</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
85
86
87
88
89</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/testing.rb', line 85</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_sidekiq_options'>sidekiq_options</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='period'>.</span><span class='id identifier rubyid_validate_worker!'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#validate_worker!-class_method" title="SidekiqUniqueJobs.validate_worker! (method)">validate_worker!</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='period'>.</span><span class='id identifier rubyid_config'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#config-class_method" title="SidekiqUniqueJobs.config (method)">config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_raise_on_config_error'>raise_on_config_error</span>
 
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</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>