<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::WWIDTimers
— Documentation by YARD 0.9.27
</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 = "Doing::WWIDTimers";
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">
<a href="../_index.html">Index (W)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">WWIDTimers</span>
</div>
<div id="search">
<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>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Doing::WWIDTimers
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="WWID.html" title="Doing::WWID (class)">WWID</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/wwid/timers.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Timer methods for WWID class</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#get_interval-instance_method" title="#get_interval (instance method)">#<strong>get_interval</strong>(item, formatted: true, record: true) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets the interval between entry's start date and @done date.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tag_times-instance_method" title="#tag_times (instance method)">#<strong>tag_times</strong>(format: :text, sort_by: :time, sort_order: :asc) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get total elapsed time for all tags in selection.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="get_interval-instance_method">
#<strong>get_interval</strong>(item, formatted: true, record: true) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gets the interval between entry's start
date and @done date</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
—
<div class='inline'><p>The entry</p>
</div>
</li>
<li>
<span class='name'>formatted</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>Return human readable
time (default seconds)</p>
</div>
</li>
<li>
<span class='name'>record</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>Add the interval to the
total for each tag</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Interval in seconds, or [d, h, m] array if
formatted is true. False if no end date or
interval is 0</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="tag_times-instance_method">
#<strong>tag_times</strong>(format: :text, sort_by: :time, sort_order: :asc) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get total elapsed time for all tags in
selection</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>format</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:text</tt>)</em>
—
<div class='inline'><p>return format (html,
json, or text)</p>
</div>
</li>
<li>
<span class='name'>sort_by</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:time</tt>)</em>
—
<div class='inline'><p>Sort by :name or :time</p>
</div>
</li>
<li>
<span class='name'>sort_order</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:asc</tt>)</em>
—
<div class='inline'><p>The sort order (:asc or :desc)</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Mar 15 17:54:06 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.0.1).
</div>
</div>
</body>
</html>