IObservableCollection

API / IObservableCollection<TItem> interface

Represents an observable collection based on the Array interface.

Extends IReadOnlyObservableCollection<TItem>.

interface IObservableCollection<TItem>
    extends IReadOnlyObservableCollection<TItem>

Source reference: src/collections/observableCollections/IObservableCollection.ts:8.

Generic Parameters

• TItem - The type of items the collection contains.

Properties

• length - Gets or sets the number of items in the collection.
• inherited readonly collectionChanged - An event that is raised when the collection changed by adding or removing items.
• inherited readonly collectionReordered - An event that is raised when the collection changed.
• inherited readonly propertiesChanged - An event that is raised when one or more properties may have changed.

Methods

• copyWithin - Copies items inside the collection overwriting existing ones.
• fill - Fills the collection with the provided item.
• get - Gets the item at the provided index.
• pop - Removes the last element from the collection and returns it. If the collection is empty, undefined is returned.
• push - Appends new elements to the end of the collection, and returns the new length of the collection.
• reverse - Reverses the items in the collections and returns the observable collection.
• set - Sets the provided item at the provided index.
• shift - Removes the first element from the collection and returns it. If the collection is empty, undefined is returned.
• sort - Reverses the items in the collections and returns the observable collection.
• splice - Removes and/or adds elements to the collection and returns the deleted elements.
• unshift - Inserts new elements at the start of the collection, and returns the new length of the collection.

Implementations

• FormCollection<TForm, TValidationError>
• ObservableCollection<TItem>

See also

• Array