Modified: olingo/site/trunk/content/doc/javascript/apidoc/utils_.html URL: http://svn.apache.org/viewvc/olingo/site/trunk/content/doc/javascript/apidoc/utils_.html?rev=1672271&r1=1672270&r2=1672271&view=diff ============================================================================== --- olingo/site/trunk/content/doc/javascript/apidoc/utils_.html (original) +++ olingo/site/trunk/content/doc/javascript/apidoc/utils_.html Thu Apr 9 09:03:39 2015 @@ -2,7 +2,7 @@ <html lang="en"> <head> <meta charset="utf-8"> - <title>JSDoc: Module: odata/utils</title> + <title>JSDoc: Module: odatajs/utils</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> @@ -17,7 +17,7 @@ <div id="main"> - <h1 class="page-title">Module: odata/utils</h1> + <h1 class="page-title">Module: odatajs/utils</h1> @@ -27,7 +27,7 @@ <header> <h2> - odata/utils + odatajs/utils </h2> </header> @@ -62,7 +62,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line2">line 2</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line21">line 21</a> </li></ul></dd> @@ -96,7 +96,7 @@ <dl> <dt> - <h4 class="name" id="dataItemTypeName"><span class="type-signature"><inner> </span>dataItemTypeName<span class="signature">(value, <span class="optional">metadata</span>)</span><span class="type-signature"> → {string}</span></h4> + <h4 class="name" id="activeXObject"><span class="type-signature"><inner> </span>activeXObject<span class="signature">(progId)</span><span class="type-signature"> → {Object}</span></h4> </dt> @@ -104,7 +104,7 @@ <div class="description"> - Gets the type name of a data item value that belongs to a feed, an entry, a complex type property, or a collection property + Creates a new ActiveXObject from the given progId. </div> @@ -126,8 +126,6 @@ <th>Type</th> - <th>Argument</th> - @@ -140,64 +138,23 @@ <tr> - <td class="name"><code>value</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - - <td class="description last">Value of the data item from which the type name is going to be retrieved.</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> + <td class="name"><code>progId</code></td> <td class="type"> -<span class="param-type">object</span> +<span class="param-type">String</span> </td> - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="description last">Object containing metadata about the data tiem.</td> + <td class="description last">ProgId string of the desired ActiveXObject.</td> </tr> @@ -228,7 +185,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line40">line 40</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line34">line 34</a> </li></ul></dd> @@ -253,9 +210,7 @@ <div class="param-desc"> - Data item type name; null if the type name cannot be found within the value or the metadata -This function will first try to get the type name from the data item's value itself if it is an object with a __metadata property; otherwise -it will try to recover it from the metadata. If both attempts fail, it will return null. + 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> @@ -266,7 +221,7 @@ it will try to recover it from the metad </dt> <dd> -<span class="param-type">string</span> +<span class="param-type">Object</span> </dd> @@ -280,7 +235,7 @@ it will try to recover it from the metad <dt> - <h4 class="name" id="forEachSchema"><span class="type-signature"><inner> </span>forEachSchema<span class="signature">(metadata, callback)</span><span class="type-signature"></span></h4> + <h4 class="name" id="assigned"><span class="type-signature"><inner> </span>assigned<span class="signature">(<span class="optional">value</span>)</span><span class="type-signature"> → {Boolean}</span></h4> </dt> @@ -288,7 +243,7 @@ it will try to recover it from the metad <div class="description"> - Invokes a function once per schema in metadata. + Checks whether the specified value is different from null and undefined. </div> @@ -310,6 +265,8 @@ it will try to recover it from the metad <th>Type</th> + <th>Argument</th> + @@ -322,7 +279,7 @@ it will try to recover it from the metad <tr> - <td class="name"><code>metadata</code></td> + <td class="name"><code>value</code></td> <td class="type"> @@ -330,33 +287,20 @@ it will try to recover it from the metad </td> - - - - <td class="description last">Metadata store; one of edmx, schema, or an array of any of them.</td> - </tr> - - - - <tr> - - <td class="name"><code>callback</code></td> - - - <td class="type"> - + <td class="attributes"> -<span class="param-type">function</span> - - - - </td> - + <optional><br> + + + + + + </td> - <td class="description last">Callback function to invoke once per schema.</td> + <td class="description last">Value to check ( may be null)</td> </tr> @@ -387,7 +331,7 @@ it will try to recover it from the metad <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line176">line 176</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line46">line 46</a> </li></ul></dd> @@ -412,11 +356,23 @@ it will try to recover it from the metad <div class="param-desc"> - The first truthy value to be returned from the callback; null or the last falsy value otherwise. + true if the value is assigned; false otherwise. </div> +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Boolean</span> + + + </dd> +</dl> + @@ -425,7 +381,7 @@ it will try to recover it from the metad <dt> - <h4 class="name" id="formatDateTimeOffset"><span class="type-signature"><inner> </span>formatDateTimeOffset<span class="signature">(value)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="contains"><span class="type-signature"><inner> </span>contains<span class="signature">(<span class="optional">arr</span>, item)</span><span class="type-signature"> → {Boolean}</span></h4> </dt> @@ -433,7 +389,7 @@ it will try to recover it from the metad <div class="description"> - Formats a DateTime or DateTimeOffset value a string. + Checks whether the specified item is in the array. </div> @@ -455,6 +411,8 @@ it will try to recover it from the metad <th>Type</th> + <th>Argument</th> + @@ -467,23 +425,59 @@ it will try to recover it from the metad <tr> - <td class="name"><code>value</code></td> + <td class="name"><code>arr</code></td> <td class="type"> -<span class="param-type">Date</span> +<span class="param-type">Array</span> </td> + <td class="attributes"> + + <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">Value to format</td> + <td class="description last">Item to look for.</td> </tr> @@ -514,7 +508,7 @@ it will try to recover it from the metad <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line234">line 234</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line55">line 55</a> </li></ul></dd> @@ -539,9 +533,7 @@ it will try to recover it from the metad <div class="param-desc"> - Formatted text. -If the value is already as string it's returned as-is -´ + true if the item is contained, false otherwise. </div> @@ -552,7 +544,7 @@ If the value is already as string it's r </dt> <dd> -<span class="param-type">String</span> +<span class="param-type">Boolean</span> </dd> @@ -566,7 +558,7 @@ If the value is already as string it's r <dt> - <h4 class="name" id="formatDuration"><span class="type-signature"><inner> </span>formatDuration<span class="signature">(value)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="defined"><span class="type-signature"><inner> </span>defined<span class="signature">(a, b)</span><span class="type-signature"></span></h4> </dt> @@ -574,7 +566,7 @@ If the value is already as string it's r <div class="description"> - Converts a duration to a string in xsd:duration format. + Given two values, picks the first one that is not undefined. </div> @@ -608,15 +600,28 @@ If the value is already as string it's r <tr> - <td class="name"><code>value</code></td> + <td class="name"><code>a</code></td> <td class="type"> - -<span class="param-type">Object</span> - - + </td> + + + + + + <td class="description last">First value.</td> + </tr> + + + + <tr> + + <td class="name"><code>b</code></td> + + + <td class="type"> </td> @@ -624,7 +629,7 @@ If the value is already as string it's r - <td class="description last">Object with ms and __edmType properties.</td> + <td class="description last">Second value.</td> </tr> @@ -655,7 +660,7 @@ If the value is already as string it's r <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line280">line 280</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line70">line 70</a> </li></ul></dd> @@ -680,23 +685,11 @@ If the value is already as string it's r <div class="param-desc"> - String representation of the time object in xsd:duration format. + a if it's a defined value; else b. </div> -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> - - - </dd> -</dl> - @@ -705,7 +698,7 @@ If the value is already as string it's r <dt> - <h4 class="name" id="formatMilliseconds"><span class="type-signature"><inner> </span>formatMilliseconds<span class="signature">(ms, ns)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="delay"><span class="type-signature"><inner> </span>delay<span class="signature">(callback)</span><span class="type-signature"></span></h4> </dt> @@ -713,7 +706,7 @@ If the value is already as string it's r <div class="description"> - Formats a millisecond and a nanosecond value into a single string. + Delays the invocation of the specified function until execution unwinds. </div> @@ -747,36 +740,13 @@ If the value is already as string it's r <tr> - <td class="name"><code>ms</code></td> - - - <td class="type"> - - -<span class="param-type">Numaber</span> - - - - </td> - - - - - - <td class="description last">Number of milliseconds to format.</param></td> - </tr> - - - - <tr> - - <td class="name"><code>ns</code></td> + <td class="name"><code>callback</code></td> <td class="type"> -<span class="param-type">Numaber</span> +<span class="param-type">function</span> @@ -786,7 +756,7 @@ If the value is already as string it's r - <td class="description last">Number of nanoseconds to format.</param></td> + <td class="description last">Callback function.</td> </tr> @@ -817,7 +787,7 @@ If the value is already as string it's r <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line208">line 208</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line77">line 77</a> </li></ul></dd> @@ -838,29 +808,6 @@ If the value is already as string it's r - <h5>Returns:</h5> - - -<div class="param-desc"> - Formatted text. -If the value is already as string it's returned as-is.</remarks> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> - - - </dd> -</dl> - - </dd> @@ -868,7 +815,7 @@ If the value is already as string it's r <dt> - <h4 class="name" id="formatNumberWidth"><span class="type-signature"><inner> </span>formatNumberWidth<span class="signature">(value, width, append)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="djsassert"><span class="type-signature"><inner> </span>djsassert<span class="signature">(condition, message, data)</span><span class="type-signature"></span></h4> </dt> @@ -876,7 +823,7 @@ If the value is already as string it's r <div class="description"> - Formats the specified value to the given width. + Throws an exception in case that a condition evaluates to false. </div> @@ -910,13 +857,13 @@ If the value is already as string it's r <tr> - <td class="name"><code>value</code></td> + <td class="name"><code>condition</code></td> <td class="type"> -<span class="param-type">Number</span> +<span class="param-type">Boolean</span> @@ -926,20 +873,20 @@ If the value is already as string it's r - <td class="description last">Number to format (non-negative).</td> + <td class="description last">Condition to evaluate.</td> </tr> <tr> - <td class="name"><code>width</code></td> + <td class="name"><code>message</code></td> <td class="type"> -<span class="param-type">Number</span> +<span class="param-type">String</span> @@ -949,20 +896,20 @@ If the value is already as string it's r - <td class="description last">Minimum width for number.</td> + <td class="description last">Message explaining the assertion.</td> </tr> <tr> - <td class="name"><code>append</code></td> + <td class="name"><code>data</code></td> <td class="type"> -<span class="param-type">Boolean</span> +<span class="param-type">Object</span> @@ -972,7 +919,7 @@ If the value is already as string it's r - <td class="description last">Flag indicating if the value is padded at the beginning (false) or at the end (true).</td> + <td class="description last">Additional data to be included in the exception.</td> </tr> @@ -1003,7 +950,7 @@ If the value is already as string it's r <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line313">line 313</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line95">line 95</a> </li></ul></dd> @@ -1024,28 +971,6 @@ If the value is already as string it's r - <h5>Returns:</h5> - - -<div class="param-desc"> - Text representation. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> - - - </dd> -</dl> - - </dd> @@ -1053,7 +978,7 @@ If the value is already as string it's r <dt> - <h4 class="name" id="getCanonicalTimezone"><span class="type-signature"><inner> </span>getCanonicalTimezone<span class="signature">(timezone)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="extend"><span class="type-signature"><inner> </span>extend<span class="signature">(target, values)</span><span class="type-signature"> → {Object}</span></h4> </dt> @@ -1061,7 +986,7 @@ If the value is already as string it's r <div class="description"> - Gets the canonical timezone representation. + Extends the target with the specified values. </div> @@ -1095,13 +1020,36 @@ If the value is already as string it's r <tr> - <td class="name"><code>timezone</code></td> + <td class="name"><code>target</code></td> <td class="type"> -<span class="param-type">String</span> +<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> @@ -1111,7 +1059,7 @@ If the value is already as string it's r - <td class="description last">Timezone representation.</td> + <td class="description last">Object with properties to add into target.</td> </tr> @@ -1142,7 +1090,7 @@ If the value is already as string it's r <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line330">line 330</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line108">line 108</a> </li></ul></dd> @@ -1167,4212 +1115,7 @@ If the value is already as string it's r <div class="param-desc"> - An 'Z' string if the timezone is absent or 0; the timezone otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="getCollectionType"><span class="type-signature"><inner> </span>getCollectionType<span class="signature">(typeName)</span><span class="type-signature"> → {String}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Gets the type of a collection type name. - </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>typeName</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Type name of the collection.</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">odata/utils.js</a>, <a href="utils.js_.html#line339">line 339</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - Type of the collection; null if the type name is not a collection type. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="getEntitySetInfo"><span class="type-signature"><inner> </span>getEntitySetInfo<span class="signature">(navigationProperty, metadata)</span><span class="type-signature"> → {Object}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Gets the entitySet info, container name and functionImports for an entitySet - </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>navigationProperty</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - - - - <td class="description last">-</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - - - - <td class="description last">-</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">odata/utils.js</a>, <a href="utils.js_.html#line741">line 741</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - The info about the entitySet. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Object</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="invokeRequest"><span class="type-signature"><inner> </span>invokeRequest<span class="signature">(request, success, error, handler, httpClient, context)</span><span class="type-signature"></span></h4> - - -</dt> -<dd> - - - <div class="description"> - Sends a request containing OData payload to a server. - </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>request</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Object that represents the request to be sent..</td> - </tr> - - - - <tr> - - <td class="name"><code>success</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Callback for a successful read operation.</td> - </tr> - - - - <tr> - - <td class="name"><code>error</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Callback for handling errors.</td> - </tr> - - - - <tr> - - <td class="name"><code>handler</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Handler for data serialization.</td> - </tr> - - - - <tr> - - <td class="name"><code>httpClient</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">HTTP client layer.</td> - </tr> - - - - <tr> - - <td class="name"><code>context</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Context used for processing the request</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">odata/utils.js</a>, <a href="utils.js_.html#line358">line 358</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - - -</dd> - - - -<dt> - <h4 class="name" id="isBatch"><span class="type-signature"><inner> </span>isBatch<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is a batch object in the library's internal representation. - </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">odata/utils.js</a>, <a href="utils.js_.html#line393">line 393</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is a batch object; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isCollection"><span class="type-signature"><inner> </span>isCollection<span class="signature">(value, typeName)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is a collection value in the library's internal representation. - </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> - - - - <tr> - - <td class="name"><code>typeName</code></td> - - - <td class="type"> - - -<span class="param-type">Sting</span> - - - - </td> - - - - - - <td class="description last">Type name of the value. This is used to disambiguate from a collection property 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">odata/utils.js</a>, <a href="utils.js_.html#line406">line 406</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is a feed value; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isCollectionType"><span class="type-signature"><inner> </span>isCollectionType<span class="signature">(typeName)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Checks whether the specified type name is a collection type. - </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>typeName</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name of type 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">odata/utils.js</a>, <a href="utils.js_.html#line418">line 418</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True if the type is the name of a collection type; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isComplex"><span class="type-signature"><inner> </span>isComplex<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is a complex type value in the library's internal representation. - </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">odata/utils.js</a>, <a href="utils.js_.html#line426">line 426</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is a complex type value; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isDateTimeOffset"><span class="type-signature"><inner> </span>isDateTimeOffset<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Checks whether a Date object is DateTimeOffset value - </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">Date</span> - - - - </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">odata/utils.js</a>, <a href="utils.js_.html#line438">line 438</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - true if the value is a DateTimeOffset, false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isDeferred"><span class="type-signature"><inner> </span>isDeferred<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is a deferred navigation property in the library's internal representation. - </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">odata/utils.js</a>, <a href="utils.js_.html#line446">line 446</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is a deferred navigation property; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isEntry"><span class="type-signature"><inner> </span>isEntry<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is an entry object in the library's internal representation. - </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">odata/utils.js</a>, <a href="utils.js_.html#line460">line 460</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is an entry object; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isFeed"><span class="type-signature"><inner> </span>isFeed<span class="signature">(value, typeName)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is a feed value in the library's internal representation. - </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> - - - - <tr> - - <td class="name"><code>typeName</code></td> - - - <td class="type"> - - -<span class="param-type">Sting</span> - - - - </td> - - - - - - <td class="description last">Type name of the value. This is used to disambiguate from a collection property 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">odata/utils.js</a>, <a href="utils.js_.html#line470">line 470</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is a feed value; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isGeographyEdmType"><span class="type-signature"><inner> </span>isGeographyEdmType<span class="signature">(typeName)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Checks whether the specified type name is a geography EDM type. - </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>typeName</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name of type 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">odata/utils.js</a>, <a href="utils.js_.html#line483">line 483</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True if the type is a geography EDM type; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isGeometryEdmType"><span class="type-signature"><inner> </span>isGeometryEdmType<span class="signature">(typeName)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Checks whether the specified type name is a geometry EDM type. - </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>typeName</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name of type 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">odata/utils.js</a>, <a href="utils.js_.html#line496">line 496</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True if the type is a geometry EDM type; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isNamedStream"><span class="type-signature"><inner> </span>isNamedStream<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is a named stream value in the library's internal representation. - </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">odata/utils.js</a>, <a href="utils.js_.html#line507">line 507</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is a named stream; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isPrimitive"><span class="type-signature"><inner> </span>isPrimitive<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Tests whether a value is a primitive type value in the library's internal representation. - </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">odata/utils.js</a>, <a href="utils.js_.html#line522">line 522</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True is the value is a primitive type value. -Date objects are considered primitive types by the library. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="isPrimitiveEdmType"><span class="type-signature"><inner> </span>isPrimitiveEdmType<span class="signature">(typeName)</span><span class="type-signature"> → {Boolean}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Checks whether the specified type name is a primitive EDM type. - </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>typeName</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name of type 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">odata/utils.js</a>, <a href="utils.js_.html#line534">line 534</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - True if the type is a primitive EDM type; false otherwise. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupComplexType"><span class="type-signature"><inner> </span>lookupComplexType<span class="signature">(name, metadata)</span><span class="type-signature"></span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up a complex type object by name. - </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>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name, possibly null or empty.</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Metadata store; one of edmx, schema, or an array of any of them.</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">odata/utils.js</a>, <a href="utils.js_.html#line618">line 618</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - A complex type description if the name is found; null otherwise.</returns> -</div> - - - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupDefaultEntityContainer"><span class="type-signature"><inner> </span>lookupDefaultEntityContainer<span class="signature">(name, metadata)</span><span class="type-signature"></span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up an - </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>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name, possibly null or empty.</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Metadata store; one of edmx, schema, or an array of any of them.</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">odata/utils.js</a>, <a href="utils.js_.html#line639">line 639</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - An entity container description if the name is found; null otherwise.</returns> -</div> - - - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupEntityContainer"><span class="type-signature"><inner> </span>lookupEntityContainer<span class="signature">(name, metadata)</span><span class="type-signature"></span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up an entity container object by name. - </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>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name, possibly null or empty.</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Metadata store; one of edmx, schema, or an array of any of them.</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">odata/utils.js</a>, <a href="utils.js_.html#line653">line 653</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - An entity container description if the name is found; null otherwise.</returns> -</div> - - - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupEntitySet"><span class="type-signature"><inner> </span>lookupEntitySet<span class="signature">(properties, name)</span><span class="type-signature"> → {Object}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up a entity set by name. - </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>properties</code></td> - - - <td class="type"> - - -<span class="param-type">Array</span> - - - - </td> - - - - - - <td class="description last">Array of entity set objects as per EDM metadata( may be null)</td> - </tr> - - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name 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">odata/utils.js</a>, <a href="utils.js_.html#line594">line 594</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - The entity set object; null if not found. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Object</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupEntityType"><span class="type-signature"><inner> </span>lookupEntityType<span class="signature">(name, metadata)</span><span class="type-signature"></span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up an entity type object by name. - </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>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name, possibly null or empty.</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Metadata store; one of edmx, schema, or an array of any of them.</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">odata/utils.js</a>, <a href="utils.js_.html#line628">line 628</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - An entity type description if the name is found; null otherwise.</returns> -</div> - - - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupFunctionImport"><span class="type-signature"><inner> </span>lookupFunctionImport<span class="signature">(properties, name)</span><span class="type-signature"> → {Object}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up a function import by name. - </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>properties</code></td> - - - <td class="type"> - - -<span class="param-type">Array</span> - - - - </td> - - - - - - <td class="description last">Array of function import objects as per EDM metadata (May be null)</td> - </tr> - - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name 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">odata/utils.js</a>, <a href="utils.js_.html#line663">line 663</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - The entity set object; null if not found. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Object</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupInMetadata"><span class="type-signature"><inner> </span>lookupInMetadata<span class="signature">(name, metadata, kind)</span><span class="type-signature"></span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up a type object by name. - </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>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name, possibly null or empty.</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Metadata store; one of edmx, schema, or an array of any of them.</td> - </tr> - - - - <tr> - - <td class="name"><code>kind</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Kind of object to look for as per EDM metadata.</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">odata/utils.js</a>, <a href="utils.js_.html#line582">line 582</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - An type description if the name is found; null otherwise -</div> - - - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupInSchema"><span class="type-signature"><inner> </span>lookupInSchema<span class="signature">(name, schema, kind)</span><span class="type-signature"></span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up a schema object by name. - </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>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name (assigned).</td> - </tr> - - - - <tr> - - <td class="name"><code>schema</code></td> - - - <td class="type"> - - </td> - - - - - - <td class="description last">Schema object as per EDM metadata.</td> - </tr> - - - - <tr> - - <td class="name"><code>kind</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Kind of object to look for as per EDM metadata.</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">odata/utils.js</a>, <a href="utils.js_.html#line779">line 779</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - An entity type description if the name is found; null otherwise.</returns> -</div> - - - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupNavigationPropertyEntitySet"><span class="type-signature"><inner> </span>lookupNavigationPropertyEntitySet<span class="signature">(navigationProperty, metadata)</span><span class="type-signature"> → {String}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up the target entityset name for a navigation property. - </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>navigationProperty</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - - - - <td class="description last">-</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - - - - <td class="description last">-</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">odata/utils.js</a>, <a href="utils.js_.html#line711">line 711</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - The entityset name for the specified property, null if not found. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupNavigationPropertyType"><span class="type-signature"><inner> </span>lookupNavigationPropertyType<span class="signature">(navigationProperty, metadata)</span><span class="type-signature"> → {String}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up the target entity type for a navigation property. - </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>navigationProperty</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - - - - <td class="description last">-</td> - </tr> - - - - <tr> - - <td class="name"><code>metadata</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - - - - <td class="description last">-</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">odata/utils.js</a>, <a href="utils.js_.html#line674">line 674</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - The entity type name for the specified property, null if not found. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupProperty"><span class="type-signature"><inner> </span>lookupProperty<span class="signature">(properties, name)</span><span class="type-signature"> → {Object}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up a property by name. - </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>properties</code></td> - - - <td class="type"> - - -<span class="param-type">Array</span> - - - - </td> - - - - - - <td class="description last">Array of property objects as per EDM metadata (may be null)</td> - </tr> - - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name 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">odata/utils.js</a>, <a href="utils.js_.html#line569">line 569</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - The property object; null if not found. -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Object</span> - - - </dd> -</dl> - - - - -</dd> - - - -<dt> - <h4 class="name" id="lookupSingleton"><span class="type-signature"><inner> </span>lookupSingleton<span class="signature">(properties, name)</span><span class="type-signature"> → {Object}</span></h4> - - -</dt> -<dd> - - - <div class="description"> - Looks up a entity set by name. - </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>properties</code></td> - - - <td class="type"> - - -<span class="param-type">Array</span> - - - - </td> - - - - - - <td class="description last">Array of entity set objects as per EDM metadata (may be null)</td> - </tr> - - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Name 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">odata/utils.js</a>, <a href="utils.js_.html#line606">line 606</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - -<div class="param-desc"> - The entity set object; null if not found. + The target object. </div> @@ -5397,7 +1140,7 @@ Date objects are considered primitive ty <dt> - <h4 class="name" id="maxVersion"><span class="type-signature"><inner> </span>maxVersion<span class="signature">(left, right)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="getURIFromInfo"><span class="type-signature"><inner> </span>getURIFromInfo<span class="signature">(uriInfo)</span><span class="type-signature"> → {String}</span></h4> </dt> @@ -5405,7 +1148,7 @@ Date objects are considered primitive ty <div class="description"> - Compares to version strings and returns the higher one. + Builds a URI string from its components. </div> @@ -5416,59 +1159,36 @@ Date objects are considered primitive ty <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>left</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </td> - - - - - - <td class="description last">Version string in the form "major.minor.rev"</td> - </tr> + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + <tbody> <tr> - <td class="name"><code>right</code></td> + <td class="name"><code>uriInfo</code></td> <td class="type"> -<span class="param-type">String</span> +<span class="param-type">Object</span> @@ -5478,7 +1198,7 @@ Date objects are considered primitive ty - <td class="description last">Version string in the form "major.minor.rev"</td> + <td class="description last">An object with uri parts (scheme, authority, etc.).</td> </tr> @@ -5509,7 +1229,7 @@ Date objects are considered primitive ty <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line798">line 798</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line250">line 250</a> </li></ul></dd> @@ -5534,7 +1254,7 @@ Date objects are considered primitive ty <div class="param-desc"> - The higher version string. + URI string. </div> @@ -5559,7 +1279,7 @@ Date objects are considered primitive ty <dt> - <h4 class="name" id="navigationPropertyKind"><span class="type-signature"><inner> </span>navigationPropertyKind<span class="signature">(value, <span class="optional">propertyModel</span>)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="getURIInfo"><span class="type-signature"><inner> </span>getURIInfo<span class="signature">(uri)</span><span class="type-signature"> → {Object}</span></h4> </dt> @@ -5567,7 +1287,7 @@ Date objects are considered primitive ty <div class="description"> - Gets the kind of a navigation property value. + Gets information about the components of the specified URI. </div> @@ -5589,8 +1309,6 @@ Date objects are considered primitive ty <th>Type</th> - <th>Argument</th> - @@ -5603,59 +1321,23 @@ Date objects are considered primitive ty <tr> - <td class="name"><code>value</code></td> - - - <td class="type"> - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - - <td class="description last">Value of the navigation property.</td> - </tr> - - - - <tr> - - <td class="name"><code>propertyModel</code></td> + <td class="name"><code>uri</code></td> <td class="type"> -<span class="param-type">Object</span> +<span class="param-type">String</span> </td> - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="description last">Object that describes the navigation property in an OData conceptual schema.</td> + <td class="description last">URI to get information from.</td> </tr> @@ -5686,7 +1368,7 @@ Date objects are considered primitive ty <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line544">line 544</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line225">line 225</a> </li></ul></dd> @@ -5711,7 +1393,7 @@ Date objects are considered primitive ty <div class="param-desc"> - String value describing the kind of the navigation property; null if the kind cannot be determined. + An object with an isAbsolute flag and part names (scheme, authority, etc.) if available. </div> @@ -5722,7 +1404,7 @@ Date objects are considered primitive ty </dt> <dd> -<span class="param-type">String</span> +<span class="param-type">Object</span> </dd> @@ -5736,7 +1418,7 @@ Date objects are considered primitive ty <dt> - <h4 class="name" id="normalizeHeaders"><span class="type-signature"><inner> </span>normalizeHeaders<span class="signature">(headers)</span><span class="type-signature"></span></h4> + <h4 class="name" id="isDate"><span class="type-signature"><inner> </span>isDate<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> </dt> @@ -5744,7 +1426,7 @@ Date objects are considered primitive ty <div class="description"> - Normalizes headers so they can be found with consistent casing. + Checks whether the specified value is a Date object. </div> @@ -5778,23 +1460,18 @@ Date objects are considered primitive ty <tr> - <td class="name"><code>headers</code></td> + <td class="name"><code>value</code></td> <td class="type"> - -<span class="param-type">Object</span> - - - </td> - <td class="description last">Dictionary of name/value pairs.</td> + <td class="description last">Value to check.</td> </tr> @@ -5825,7 +1502,7 @@ Date objects are considered primitive ty <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="utils.js_.html">odata/utils.js</a>, <a href="utils.js_.html#line852">line 852</a> + <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line147">line 147</a> </li></ul></dd> @@ -5846,6 +1523,28 @@ Date objects are considered primitive ty + <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> @@ -5853,7 +1552,7 @@ Date objects are considered primitive ty <dt> - <h4 class="name" id="parseBool"><span class="type-signature"><inner> </span>parseBool<span class="signature">(propertyValue)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="isObject"><span class="type-signature"><inner> </span>isObject<span class="signature">(value)</span><span class="type-signature"> → {Boolean}</span></h4> </dt> @@ -5861,7 +1560,7 @@ Date objects are considered primitive ty <div class="description"> - Parses a string into a boolean value. + Tests whether a value is an object. </div> @@ -5895,7 +1594,7 @@ Date objects are considered primitive ty <tr> - <td class="name"><code>propertyValue</code></td> + <td class="name"><code>value</code></td>
[... 852 lines stripped ...]
