mhenrixon/sidekiq-unique-jobs

View on GitHub
doc/SidekiqUniqueJobs/Reflectable.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: SidekiqUniqueJobs::Reflectable
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 = "SidekiqUniqueJobs::Reflectable";
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 (R)</a> &raquo;
<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.
&raquo;
<span class="title">Reflectable</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::Reflectable
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="Lock/BaseLock.html" title="SidekiqUniqueJobs::Lock::BaseLock (class)">Lock::BaseLock</a></span>, <span class='object_link'><a href="Locksmith.html" title="SidekiqUniqueJobs::Locksmith (class)">Locksmith</a></span>, <span class='object_link'><a href="Middleware/Client.html" title="SidekiqUniqueJobs::Middleware::Client (class)">Middleware::Client</a></span>, <span class='object_link'><a href="OnConflict/Reschedule.html" title="SidekiqUniqueJobs::OnConflict::Reschedule (class)">OnConflict::Reschedule</a></span></dd>
</dl>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/reflectable.rb</dd>
</dl>
Unexpected trailing spaces found.
</div>
 
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Module Reflectable provides a method to notify subscribers</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>
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="#reflect-instance_method" title="#reflect (instance method)">#<strong>reflect</strong>(reflection, *args) &#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>Reflects on specific event.</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="reflect-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>reflect</strong>(reflection, *args) &#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>Reflects on specific event</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'>reflection</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>Symbol</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the reflected event</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>args</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>arguments to provide to reflector</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
18
19
20
21
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/reflectable.rb', line 18</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_reflect'>reflect</span><span class='lparen'>(</span><span class='id identifier rubyid_reflection'>reflection</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</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_reflections'><span class='object_link'><a href="../SidekiqUniqueJobs.html#reflections-class_method" title="SidekiqUniqueJobs.reflections (method)">reflections</a></span></span><span class='period'>.</span><span class='id identifier rubyid_dispatch'><span class='object_link'><a href="Reflections.html#dispatch-instance_method" title="SidekiqUniqueJobs::Reflections#dispatch (method)">dispatch</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_reflection'>reflection</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='kw'>nil</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="UniqueJobsError.html" title="SidekiqUniqueJobs::UniqueJobsError (class)">UniqueJobsError</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_ex'>ex</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_logger'><span class='object_link'><a href="../SidekiqUniqueJobs.html#logger-class_method" title="SidekiqUniqueJobs.logger (method)">logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_ex'>ex</span><span class='rparen'>)</span>
<span class='kw'>nil</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>