angular.Object.equals.html

<h1>angular.Object.equals</h1>
<div class="angular-object-equals"><h2>Description</h2>
<div class="description"><p>Determines if two objects or two values are equivalent. Supports value types, arrays and
objects.</p>

<p>Two objects or values are considered equivalent if at least one of the following is true:</p>

<ul>
<li>Both objects or values pass <code>===</code> comparison.</li>
<li>Both objects or values are of the same type and all of their properties pass <code>===</code> comparison.</li>
</ul>

<p>During a property comparision, properties of <code>function</code> type and properties with names
that begin with <code>$</code> are ignored.</p>

<p>Note: This function is used to augment the Object type in Angular expressions. See
<a href="#!/api/angular.Array"><code>angular.Array</code></a> for more information about Angular arrays.</p></div>
<h2>Usage</h2>
<div class="usage"><div ng:non-bindable=""><pre class="brush: js; html-script: true;">angular.Object.equals(o1, o2);</pre>
</div>
<h3>Parameters</h3>
<ul class="parameters"><li><code ng:non-bindable="">o1 – {*} – </code>
<p>Object or value to compare.</p></li>
<li><code ng:non-bindable="">o2 – {*} – </code>
<p>Object or value to compare.</p></li>
</ul>
<h3>Returns</h3>
<div class="returns"><code ng:non-bindable="">{boolean}</code>
– <p>True if arguments are equal.</p></div>
</div>
<h2>Example</h2>
<div class="example"><doc:example>
<pre class="doc-source">
    Salutation: &lt;input type="text" name="greeting.salutation" value="Hello" /&gt;&lt;br/&gt;
    Name: &lt;input type="text" name="greeting.name" value="world"/&gt;&lt;br/&gt;
    &lt;hr/&gt;

    The &lt;code&gt;greeting&lt;/code&gt; object is
    &lt;span ng:hide="greeting.$equals({salutation:'Hello', name:'world'})"&gt;NOT&lt;/span&gt; equal to
    &lt;code&gt;{salutation:'Hello', name:'world'}&lt;/code&gt;.

    &lt;pre&gt;greeting={{greeting}}&lt;/pre&gt;
</pre>
<pre class="doc-scenario">
    it('should print that initialy greeting is equal to the hardcoded value object', function() {
      expect(element('.doc-example-live input[name=greeting.salutation]').val()).toBe('Hello');
      expect(element('.doc-example-live input[name=greeting.name]').val()).toBe('world');
      expect(element('.doc-example-live span').css('display')).toBe('none');
    });

    it('should say that the objects are not equal when the form is modified', function() {
      input('greeting.name').enter('kitty');
      expect(element('.doc-example-live span').css('display')).toBe('inline');
    });
</pre>
</doc:example></div>
</div>