angular.Array.remove.html

<h1>angular.Array.remove</h1>
<fieldset class="workInProgress"><legend>Work in Progress</legend>
This page is currently being revised. It might be incomplete or contain inaccuracies.</fieldset>
<h2>Description</h2>
<p>Modifies <code>array</code> by removing an element from it. The element will be looked up using the
<a href="#!angular.Array.indexOf"><code>indexOf</code></a> function on the <code>array</code> and only the first instance of
the element will be removed.</p>

<p>Note: this function is used to augment the Array type in angular expressions. See
<a href="#!angular.Array"><code>angular.Array</code></a> for more info.</p><h2>Usage</h2>
<div ng:non-bindable=""><pre class="brush: js; html-script: true;">angular.Array.remove(array, value);</pre>
</div>
<h3>Parameters</h3>
<ul class="parameters"><li><code ng:non-bindable="">array – {Array} – </code>
Array from which an element should be removed.</li>
<li><code ng:non-bindable="">value – {*} – </code>
Element to be removed.</li>
</ul>
<h3>Returns</h3>
<code ng:non-bindable="">*</code>
– The removed element.<h2>Example</h2>
<doc:example><doc:source>&lt;ul ng:init="tasks=['Learn Angular', 'Read Documentation',
                    'Check out demos', 'Build cool applications']"&gt;
  &lt;li ng:repeat="task in tasks"&gt;
    {{task}} [&lt;a href="" ng:click="tasks.$remove(task)"&gt;X&lt;/a&gt;]
  &lt;/li&gt;
&lt;/ul&gt;
&lt;hr/&gt;
tasks = {{tasks}}</doc:source>
<doc:scenario>it('should initialize the task list with for tasks', function() {
  expect(repeater('.doc-example ul li', 'task in tasks').count()).toBe(4);
  expect(repeater('.doc-example ul li', 'task in tasks').column('task')).
    toEqual(['Learn Angular', 'Read Documentation', 'Check out demos',
             'Build cool applications']);
});

it('should initialize the task list with for tasks', function() {
  element('.doc-example ul li a:contains("X"):first').click();
  expect(repeater('.doc-example ul li', 'task in tasks').count()).toBe(3);

  element('.doc-example ul li a:contains("X"):last').click();
  expect(repeater('.doc-example ul li', 'task in tasks').count()).toBe(2);

  expect(repeater('.doc-example ul li', 'task in tasks').column('task')).
    toEqual(['Read Documentation', 'Check out demos']);
});</doc:scenario>
</doc:example>