content/doc/javascript/apidoc/utils_.html - olingo-site - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="utf-8">
     <title>JSDoc: Module: odatajs/utils</title>

     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
 </head>

 <body>

 <div id="main">

     <h1 class="page-title">Module: odatajs/utils</h1>


 <section>

 <header>
     <h2>
     odatajs/utils
     </h2>

 </header>

 <article>
     <div class="container-overview">


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line21">line 21</a>
     </li></ul></dd>


 </dl>


     </div>


         <h3 class="subsection-title">Methods</h3>

         <dl>

 <dt>
     <h4 class="name" id="activeXObject"><span class="type-signature">&lt;inner> </span>activeXObject<span class="signature">(progId)</span><span class="type-signature"> &rarr; {Object}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Creates a new ActiveXObject from the given progId.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>progId</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">ProgId string of the desired ActiveXObject.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line34">line 34</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     The ActiveXObject instance. Null if ActiveX is not supported by the browser.
 This function throws whatever exception might occur during the creation
 of the ActiveXObject.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Object</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="assigned"><span class="type-signature">&lt;inner> </span>assigned<span class="signature">(<span class="optional">value</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Checks whether the specified value is different from null and undefined.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th>Argument</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>value</code></td>


             <td class="type">

             </td>


                 <td class="attributes">

                     &lt;optional><br>


                 </td>


             <td class="description last">Value to check ( may be null)</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line46">line 46</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     true if the value is assigned; false otherwise.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Boolean</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="contains"><span class="type-signature">&lt;inner> </span>contains<span class="signature">(<span class="optional">arr</span>, item)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Checks whether the specified item is in the array.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th>Argument</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>arr</code></td>


             <td class="type">


 <span class="param-type">Array</span>


             </td>


                 <td class="attributes">

                     &lt;optional><br>


                 </td>


             <td class="description last">Array to check in.</td>
         </tr>


         <tr>

                 <td class="name"><code>item</code></td>


             <td class="type">

             </td>


                 <td class="attributes">


                 </td>


             <td class="description last">Item to look for.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line55">line 55</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     true if the item is contained, false otherwise.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Boolean</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="defined"><span class="type-signature">&lt;inner> </span>defined<span class="signature">(a, b)</span><span class="type-signature"></span></h4>


 </dt>
 <dd>


     <div class="description">
         Given two values, picks the first one that is not undefined.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>a</code></td>


             <td class="type">

             </td>


             <td class="description last">First value.</td>
         </tr>


         <tr>

                 <td class="name"><code>b</code></td>


             <td class="type">

             </td>


             <td class="description last">Second value.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line70">line 70</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     a if it's a defined value; else b.
 </div>


 </dd>


 <dt>
     <h4 class="name" id="delay"><span class="type-signature">&lt;inner> </span>delay<span class="signature">(callback)</span><span class="type-signature"></span></h4>


 </dt>
 <dd>


     <div class="description">
         Delays the invocation of the specified function until execution unwinds.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>callback</code></td>


             <td class="type">


 <span class="param-type">function</span>


             </td>


             <td class="description last">Callback function.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line77">line 77</a>
     </li></ul></dd>


 </dl>


 </dd>


 <dt>
     <h4 class="name" id="djsassert"><span class="type-signature">&lt;inner> </span>djsassert<span class="signature">(condition, message, data)</span><span class="type-signature"></span></h4>


 </dt>
 <dd>


     <div class="description">
         Throws an exception in case that a condition evaluates to false.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>condition</code></td>


             <td class="type">


 <span class="param-type">Boolean</span>


             </td>


             <td class="description last">Condition to evaluate.</td>
         </tr>


         <tr>

                 <td class="name"><code>message</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">Message explaining the assertion.</td>
         </tr>


         <tr>

                 <td class="name"><code>data</code></td>


             <td class="type">


 <span class="param-type">Object</span>


             </td>


             <td class="description last">Additional data to be included in the exception.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line95">line 95</a>
     </li></ul></dd>


 </dl>


 </dd>


 <dt>
     <h4 class="name" id="extend"><span class="type-signature">&lt;inner> </span>extend<span class="signature">(target, values)</span><span class="type-signature"> &rarr; {Object}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Extends the target with the specified values.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>target</code></td>


             <td class="type">


 <span class="param-type">Object</span>


             </td>


             <td class="description last">Object to add properties to.</td>
         </tr>


         <tr>

                 <td class="name"><code>values</code></td>


             <td class="type">


 <span class="param-type">Object</span>


             </td>


             <td class="description last">Object with properties to add into target.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line108">line 108</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     The target object.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Object</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="getURIFromInfo"><span class="type-signature">&lt;inner> </span>getURIFromInfo<span class="signature">(uriInfo)</span><span class="type-signature"> &rarr; {String}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Builds a URI string from its components.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>uriInfo</code></td>


             <td class="type">


 <span class="param-type">Object</span>


             </td>


             <td class="description last">An object with uri parts (scheme, authority, etc.).</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line250">line 250</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     URI string.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">String</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="getURIInfo"><span class="type-signature">&lt;inner> </span>getURIInfo<span class="signature">(uri)</span><span class="type-signature"> &rarr; {Object}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Gets information about the components of the specified URI.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>uri</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">URI to get information from.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line225">line 225</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     An object with an isAbsolute flag and part names (scheme, authority, etc.) if available.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Object</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="isDate"><span class="type-signature">&lt;inner> </span>isDate<span class="signature">(value)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Checks whether the specified value is a Date object.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>value</code></td>


             <td class="type">

             </td>


             <td class="description last">Value to check.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line147">line 147</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     true if the value is a Date object; false otherwise.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Boolean</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="isObject"><span class="type-signature">&lt;inner> </span>isObject<span class="signature">(value)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Tests whether a value is an object.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>value</code></td>


             <td class="type">

             </td>


             <td class="description last">Value to test.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line156">line 156</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     True is the value is an object; false otherwise.
 Per javascript rules, null and array values are objects and will cause this function to return true.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Boolean</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="mergeUriPathWithBase"><span class="type-signature">&lt;inner> </span>mergeUriPathWithBase<span class="signature">(uriPath, basePath)</span><span class="type-signature"> &rarr; {String}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Merges the path of a relative URI and a base URI.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>uriPath</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">Relative URI path.</td>
         </tr>


         <tr>

                 <td class="name"><code>basePath</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">Base URI path.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line349">line 349</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     A string with the merged path.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">String</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="normalizeURI"><span class="type-signature">&lt;inner> </span>normalizeURI<span class="signature">(uri, base)</span><span class="type-signature"> &rarr; {String}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Normalizes a possibly relative URI with a base URI.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>uri</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">URI to normalize, absolute or relative</td>
         </tr>


         <tr>

                 <td class="name"><code>base</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">Base URI to compose with (may be null)</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line303">line 303</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     The composed URI if relative; the original one if absolute.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">String</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="normalizeURICase"><span class="type-signature">&lt;inner> </span>normalizeURICase<span class="signature">(uri)</span><span class="type-signature"> &rarr; {String}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Normalizes the casing of a URI.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>uri</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">URI to normalize, absolute or relative.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line273">line 273</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     The URI normalized to lower case.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">String</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="parseInt10"><span class="type-signature">&lt;inner> </span>parseInt10<span class="signature">(value)</span><span class="type-signature"> &rarr; {Number}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Parses a value in base 10.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>value</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">String value to parse.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line164">line 164</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     The parsed value, NaN if not a valid value.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">Number</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="removeDotsFromPath"><span class="type-signature">&lt;inner> </span>removeDotsFromPath<span class="signature">(path)</span><span class="type-signature"> &rarr; {String}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Removes the special folders . and .. from a URI's path.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>path</code></td>


             <td class="type">


 <span class="param-type">string</span>


             </td>


             <td class="description last">URI path component.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line369">line 369</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     Path without any . and .. folders.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">String</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="renameProperty"><span class="type-signature">&lt;inner> </span>renameProperty<span class="signature">(obj, oldName, newName)</span><span class="type-signature"></span></h4>


 </dt>
 <dd>


     <div class="description">
         Renames a property in an object.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>obj</code></td>


             <td class="type">


 <span class="param-type">Object</span>


             </td>


             <td class="description last">Object in which the property will be renamed.</td>
         </tr>


         <tr>

                 <td class="name"><code>oldName</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">Name of the property that will be renamed.</td>
         </tr>


         <tr>

                 <td class="name"><code>newName</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">New name of the property.
 This function will not do anything if the object doesn't own a property with the specified old name.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line174">line 174</a>
     </li></ul></dd>


 </dl>


 </dd>


 <dt>
     <h4 class="name" id="throwErrorCallback"><span class="type-signature">&lt;inner> </span>throwErrorCallback<span class="signature">(error)</span><span class="type-signature"></span></h4>


 </dt>
 <dd>


     <div class="description">
         Default error handler.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>error</code></td>


             <td class="type">


 <span class="param-type">Object</span>


             </td>


             <td class="description last">Error to handle.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line184">line 184</a>
     </li></ul></dd>


 </dl>


 </dd>


 <dt>
     <h4 class="name" id="trimString"><span class="type-signature">&lt;inner> </span>trimString<span class="signature">(str)</span><span class="type-signature"> &rarr; {String}</span></h4>


 </dt>
 <dd>


     <div class="description">
         Removes leading and trailing whitespaces from a string.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>str</code></td>


             <td class="type">


 <span class="param-type">String</span>


             </td>


             <td class="description last">String to trim</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line192">line 192</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     The string with no leading or trailing whitespace.
 </div>


 <dl>
 	<dt>
 		Type
 	</dt>
 	<dd>

 <span class="param-type">String</span>


 	</dd>
 </dl>


 </dd>


 <dt>
     <h4 class="name" id="undefinedDefault"><span class="type-signature">&lt;inner> </span>undefinedDefault<span class="signature">(<span class="optional">value</span>, defaultValue)</span><span class="type-signature"></span></h4>


 </dt>
 <dd>


     <div class="description">
         Returns a default value in place of undefined.
     </div>


         <h5>Parameters:</h5>


 <table class="params">
     <thead>
 	<tr>

 		<th>Name</th>


 		<th>Type</th>


 		<th>Argument</th>


 		<th class="last">Description</th>
 	</tr>
 	</thead>

 	<tbody>


         <tr>

                 <td class="name"><code>value</code></td>


             <td class="type">

             </td>


                 <td class="attributes">

                     &lt;optional><br>


                 </td>


             <td class="description last">Value to check (may be null)</td>
         </tr>


         <tr>

                 <td class="name"><code>defaultValue</code></td>


             <td class="type">

             </td>


                 <td class="attributes">


                 </td>


             <td class="description last">Value to return if value is undefined.</td>
         </tr>


 	</tbody>
 </table>


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line207">line 207</a>
     </li></ul></dd>


 </dl>


     <h5>Returns:</h5>


 <div class="param-desc">
     value if it's defined; defaultValue otherwise.
 This should only be used for cases where falsy values are valid;
 otherwise the pattern should be 'x = (value) ? value : defaultValue;'.
 </div>


 </dd>

         </dl>


 </article>

 </section>


 </div>

 <nav>
     <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cache.html">cache</a></li><li><a href="source.html">cache/source</a></li><li><a href="module-odata.html">odata</a></li><li><a href="batch.html">odata/batch</a></li><li><a href="handler.html">odata/handler</a></li><li><a href="json.html">odata/json</a></li><li><a href="metadata.html">odata/metadata</a></li><li><a href="net.html">odata/net</a></li><li><a href="utils.html">odata/utils</a></li><li><a href="deferred.html">odatajs/deferred</a></li><li><a href="utils_.html">odatajs/utils</a></li><li><a href="xml.html">odatajs/xml</a></li><li><a href="module-store.html">store</a></li><li><a href="dom.html">store/dom</a></li><li><a href="indexeddb.html">store/indexeddb</a></li><li><a href="memory.html">store/memory</a></li></ul><h3>Classes</h3><ul><li><a href="DataCache.html">DataCache</a></li><li><a href="DataCacheOperation.html">DataCacheOperation</a></li><li><a href="DjsDeferred.html">DjsDeferred</a></li><li><a href="dom-DomStore.html">DomStore</a></li><li><a href="indexeddb-IndexedDBStore.html">IndexedDBStore</a></li><li><a href="memory-MemoryStore.html">MemoryStore</a></li><li><a href="ODataCacheSource.html">ODataCacheSource</a></li></ul><h3><a href="global.html">Global</a></h3>
 </nav>

 <br clear="both">

 <footer>
     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Apr 09 2015 08:31:26 GMT+0200 (MESZ)
 </footer>

 <script> prettyPrint(); </script>
 <script src="scripts/linenumber.js"> </script>
 </body>
 </html>