<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Module: Doing::ChronifyArray — Documentation by YARD 0.9.34 </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::ChronifyArray"; 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 (C)</a> » <span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span> » <span class="title">ChronifyArray</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::ChronifyArray </h1> <div class="box_info"> <dl> <dt>Included in:</dt> <dd><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/doing/chronify/array.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Chronify array helpers</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="#time_string-instance_method" title="#time_string (instance method)">#<strong>time_string</strong>(format: :dhm) ⇒ String </a> </span> <span class="summary_desc"><div class='inline'><p>Format [d, h, m] as string.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_abbr-instance_method" title="#to_abbr (instance method)">#<strong>to_abbr</strong>(years: false, separator: '') ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_natural-instance_method" title="#to_natural (instance method)">#<strong>to_natural</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_years-instance_method" title="#to_years (instance method)">#<strong>to_years</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Convert [d, h, m] to [y, d, h, m].</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="time_string-instance_method"> #<strong>time_string</strong>(format: :dhm) ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Format [d, h, m] as string</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="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span> <em class="default">(defaults to: <tt>:dhm</tt>)</em> — <div class='inline'><p>The format, :dhm, :hm, :m, :clock, :natural</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span> — <div class='inline'><p>formatted string</p> </div> </li> </ul> <p class="tag_title">Raises:</p> <ul class="raise"> <li> <span class='type'>(<tt>InvalidArgument</tt>)</span> </li> </ul> </div> </div> <div class="method_details "> <h3 class="signature " id="to_abbr-instance_method"> #<strong>to_abbr</strong>(years: false, separator: '') ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="to_natural-instance_method"> #<strong>to_natural</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="to_years-instance_method"> #<strong>to_years</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Convert [d, h, m] to [y, d, h, m]</p> </div> </div> <div class="tags"> </div> </div> </div> </div> <div id="footer"> Generated on Sat Jul 1 12:43:13 2023 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.34 (ruby-3.2.0). </div> </div> </body> </html>