doc/Contentful/ArrayLike.html in contentful-2.13.0 vs doc/Contentful/ArrayLike.html in contentful-2.13.1

- old
+ new

@@ -1,624 +1,624 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Module: Contentful::ArrayLike - - &mdash; Documentation by YARD 0.9.19 - -</title> - - <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" /> - - <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" /> - -<script type="text/javascript" charset="utf-8"> - pathId = "Contentful::ArrayLike"; - 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 (A)</a> &raquo; - <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span> - &raquo; - <span class="title">ArrayLike</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: Contentful::ArrayLike - - - -</h1> -<div class="box_info"> - - - - - - - <dl> - <dt>Includes:</dt> - <dd>Enumerable</dd> - </dl> - - - - - <dl> - <dt>Included in:</dt> - <dd><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Array</a></span>, <span class='object_link'><a href="SyncPage.html" title="Contentful::SyncPage (class)">SyncPage</a></span></dd> - </dl> - - - - <dl> - <dt>Defined in:</dt> - <dd>lib/contentful/array_like.rb</dd> - </dl> - -</div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title> + Module: Contentful::ArrayLike + + &mdash; Documentation by YARD 0.9.18 + +</title> + + <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" /> + + <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + pathId = "Contentful::ArrayLike"; + 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 (A)</a> &raquo; + <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span> + &raquo; + <span class="title">ArrayLike</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: Contentful::ArrayLike + + + +</h1> +<div class="box_info"> + + + + + + + <dl> + <dt>Includes:</dt> + <dd>Enumerable</dd> + </dl> + + + + + <dl> + <dt>Included in:</dt> + <dd><span class='object_link'><a href="Array.html" title="Contentful::Array (class)">Array</a></span>, <span class='object_link'><a href="SyncPage.html" title="Contentful::SyncPage (class)">SyncPage</a></span></dd> + </dl> + + + + <dl> + <dt>Defined in:</dt> + <dd>lib/contentful/array_like.rb</dd> + </dl> + +</div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> <p>Useful methods for array-like resources that can be included if an :items property exists</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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(index) &#x21d2; Contentful::Entry, Contentful::Asset </a> - - - - </span> - - - - - - - - - + + + </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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(index) &#x21d2; Contentful::Entry, Contentful::Asset </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Delegates to items#[].</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#array%3F-instance_method" title="#array? (instance method)">#<strong>array?</strong> &#x21d2; true </a> - - - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#array%3F-instance_method" title="#array? (instance method)">#<strong>array?</strong> &#x21d2; true </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Returns true for array-like resources.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#each_item-instance_method" title="#each_item (instance method)">#<strong>each_item</strong> {|Contentful::Entry, Contentful::Asset| ... } &#x21d2; Object </a> - - - - (also: #each) - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#each_item-instance_method" title="#each_item (instance method)">#<strong>each_item</strong> {|Contentful::Entry, Contentful::Asset| ... } &#x21d2; Object </a> + + + + (also: #each) + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Delegates to items#each.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong> &#x21d2; Boolean </a> - - - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong> &#x21d2; Boolean </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Delegates to items#empty?.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#last-instance_method" title="#last (instance method)">#<strong>last</strong> &#x21d2; Contentful::Entry, Contentful::Asset </a> - - - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#last-instance_method" title="#last (instance method)">#<strong>last</strong> &#x21d2; Contentful::Entry, Contentful::Asset </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Delegates to items#last.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#size-instance_method" title="#size (instance method)">#<strong>size</strong> &#x21d2; Number </a> - - - - (also: #length) - - </span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#size-instance_method" title="#size (instance method)">#<strong>size</strong> &#x21d2; Number </a> + + + + (also: #length) + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Delegetes to items#size.</p> -</div></span> - -</li> - - - </ul> - - - - - - <div id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> - +</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="[]-instance_method"> + + #<strong>[]</strong>(index) &#x21d2; <tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details first"> - <h3 class="signature first" id="[]-instance_method"> - - #<strong>[]</strong>(index) &#x21d2; <tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - <p>Delegates to items#[]</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 40 41 -42</pre> - </td> - <td> +42</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/array_like.rb', line 40</span> <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span> <span class='id identifier rubyid_items'>items</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="array?-instance_method"> + + #<strong>array?</strong> &#x21d2; <tt>true</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details "> - <h3 class="signature " id="array?-instance_method"> - - #<strong>array?</strong> &#x21d2; <tt>true</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - <p>Returns true for array-like resources</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>true</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>true</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 10 11 -12</pre> - </td> - <td> +12</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/array_like.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_array?'>array?</span> <span class='kw'>true</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="each_item-instance_method"> + + #<strong>each_item</strong> {|Contentful::Entry, Contentful::Asset| ... } &#x21d2; <tt>Object</tt> + + + + <span class="aliases">Also known as: + <span class="names"><span id='each-instance_method'>each</span></span> + </span> + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details "> - <h3 class="signature " id="each_item-instance_method"> - - #<strong>each_item</strong> {|Contentful::Entry, Contentful::Asset| ... } &#x21d2; <tt>Object</tt> - - - - <span class="aliases">Also known as: - <span class="names"><span id='each-instance_method'>each</span></span> - </span> - - - -</h3><div class="docstring"> - <div class="discussion"> - <p>Delegates to items#each</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Yields:</p> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Yields:</p> +<ul class="yield"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 17 18 -19</pre> - </td> - <td> +19</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/array_like.rb', line 17</span> <span class='kw'>def</span> <span class='id identifier rubyid_each_item'>each_item</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="empty?-instance_method"> + + #<strong>empty?</strong> &#x21d2; <tt>Boolean</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details "> - <h3 class="signature " id="empty?-instance_method"> - - #<strong>empty?</strong> &#x21d2; <tt>Boolean</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - <p>Delegates to items#empty?</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 25 26 -27</pre> - </td> - <td> +27</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/array_like.rb', line 25</span> <span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span> <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="last-instance_method"> + + #<strong>last</strong> &#x21d2; <tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details "> - <h3 class="signature " id="last-instance_method"> - - #<strong>last</strong> &#x21d2; <tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - <p>Delegates to items#last</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Entry.html" title="Contentful::Entry (class)">Contentful::Entry</a></span></tt>, <tt><span class='object_link'><a href="Asset.html" title="Contentful::Asset (class)">Contentful::Asset</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 47 48 -49</pre> - </td> - <td> +49</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/array_like.rb', line 47</span> <span class='kw'>def</span> <span class='id identifier rubyid_last'>last</span> <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="size-instance_method"> + + #<strong>size</strong> &#x21d2; <tt>Number</tt> + + + + <span class="aliases">Also known as: + <span class="names"><span id='length-instance_method'>length</span></span> + </span> + + + +</h3><div class="docstring"> + <div class="discussion"> - <div class="method_details "> - <h3 class="signature " id="size-instance_method"> - - #<strong>size</strong> &#x21d2; <tt>Number</tt> - - - - <span class="aliases">Also known as: - <span class="names"><span id='length-instance_method'>length</span></span> - </span> - - - -</h3><div class="docstring"> - <div class="discussion"> - <p>Delegetes to items#size</p> - - - </div> -</div> -<div class="tags"> - -<p class="tag_title">Returns:</p> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Number</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Number</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 32 33 -34</pre> - </td> - <td> +34</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/array_like.rb', line 32</span> <span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span> <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Wed Jun 26 15:30:21 2019 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.19 (ruby-2.6.1). -</div> - - </div> - </body> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Mon Jul 8 11:40:17 2019 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.9.18 (ruby-2.6.3). +</div> + + </div> + </body> </html> \ No newline at end of file