IList
Defined in: packages/data/src/list/ilist.ts:29
Interface representing an ordered data collection.
The list does not allow undefined as a valid element.
The list may or may not be optimized for random access, depending on the implementation.
Contrary to Javascript Array, the list cannot be sparse (i.e., it cannot have
“holes” or missing elements). All indices between 0 and count() - 1 are
guaranteed to be valid.
Extends
Section titled “Extends”ICollection<T>.ISearchable<T>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T extends DefinedValue = DefinedValue
The type of elements in the list. Anything except undefined,
which means “no element”.
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
Iterator<T,any,any>
Defined in: node_modules/.store/typescript-npm-6.0.3-585eecd158/package/lib/lib.es2015.iterable.d.ts:47
Returns
Section titled “Returns”Iterator<T, any, any>
Inherited from
Section titled “Inherited from”clear()
Section titled “clear()”clear():
void
Defined in: packages/data/src/collection/icollection.ts:23
Removes all elements from the collection.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”count()
Section titled “count()”count():
number
Defined in: packages/data/src/collection/icollection.ts:20
The number of elements in the collection.
A method, not a getter: its async counterpart needs a round trip to the backing store, and a member must have the same shape in both.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”get(
index):T|undefined
Defined in: packages/data/src/list/ilist.ts:49
Returns the item at the specified index.
If the index is negative, it counts from the end of the list. If the index
is out of bounds, undefined is returned.
Not uniformly O(1). This member reads as positional access, but only a
random-access backing answers it in constant time. On a linked backing, it
walks from an end, so a loop calling get over every index is quadratic.
Iterate the list, or take a cursor
(ICursorSequence/IBidirectionalCursorSequence), whenever
the access pattern is sequential. Each implementation states its own
complexity.
Parameters
Section titled “Parameters”number
The index of the item to retrieve.
Returns
Section titled “Returns”T | undefined
The item at the specified index, or undefined if the index is
out of bounds.
remove()
Section titled “remove()”remove(
condition):IterableIterator<T>
Defined in: packages/data/src/collection/isearchable.ts:19
Removes every item matching the given predicate.
Parameters
Section titled “Parameters”condition
Section titled “condition”Predicate<[T]>
A predicate function to identify the items to remove.
Returns
Section titled “Returns”IterableIterator<T>
An iterator of the removed items.
Inherited from
Section titled “Inherited from”removeFirst()
Section titled “removeFirst()”removeFirst(
condition):boolean
Defined in: packages/data/src/collection/isearchable.ts:11
Removes the first occurrence of the item matching the given predicate.
Parameters
Section titled “Parameters”condition
Section titled “condition”Predicate<[T]>
A predicate function to identify the item to remove.
Returns
Section titled “Returns”boolean
true if the item was found and removed, false otherwise.
Inherited from
Section titled “Inherited from”replace()
Section titled “replace()”replace(
condition,newItemFactory):IterableIterator<T>
Defined in: packages/data/src/collection/isearchable.ts:38
Replaces every item matching the given predicate.
Parameters
Section titled “Parameters”condition
Section titled “condition”Predicate<[T]>
A predicate function to identify the items to replace.
newItemFactory
Section titled “newItemFactory”Callable<[T], T>
A function that takes the old item and returns the new item to insert.
Returns
Section titled “Returns”IterableIterator<T>
An iterator of the replaced items.
Inherited from
Section titled “Inherited from”replaceFirst()
Section titled “replaceFirst()”replaceFirst(
condition,newItem):boolean
Defined in: packages/data/src/collection/isearchable.ts:28
Replaces the first occurrence of the item matching the given predicate.
Parameters
Section titled “Parameters”condition
Section titled “condition”Predicate<[T]>
A predicate function to identify the item to replace.
newItem
Section titled “newItem”T
The new item to insert.
Returns
Section titled “Returns”boolean
true if the item was found and replaced, false otherwise.
Inherited from
Section titled “Inherited from”set(
index,item):void
Defined in: packages/data/src/list/ilist.ts:62
Sets the item at the specified index.
If the index is negative, it counts from the end of the list. If the index is equal to the length of the list, the item is appended to the end. If the index is out of bounds, a RangeError is thrown.
Parameters
Section titled “Parameters”number
The index at which to set the item.
T
The item to set.
Returns
Section titled “Returns”void
Throws
Section titled “Throws”If the index is out of bounds.
slice()
Section titled “slice()”slice(
start?,end?):IterableIterator<T>
Defined in: packages/data/src/list/ilist.ts:131
Slice the list to a new list from start to end.
This method does not mutate the original list.
The range is specified by the start and end parameters, which are
inclusive and exclusive, respectively. If start is omitted, it defaults
to 0. If end is omitted, it defaults to the length of the list.
If either start or end is negative, they refer to positions from the
end of the list. For example, -1 refers to the last element, -2 refers
to the second last element, and so on.
If start is greater than or equal to end, the result is an empty
iterator.
If the start index is out of bounds, a RangeError is thrown. If end is
out of bounds, it is clamped to the valid range.
Parameters
Section titled “Parameters”start?
Section titled “start?”number
Optional start index of the range (inclusive).
number
Optional end index of the range (exclusive).
Returns
Section titled “Returns”IterableIterator<T>
An iterator for the elements in the specified range.
Throws
Section titled “Throws”If the start index is out of bounds.
splice()
Section titled “splice()”splice(
start,deleteCount?,item?):IterableIterator<T>
Defined in: packages/data/src/list/ilist.ts:88
Change the content of the list by removing or replacing existing elements and/or adding new elements in place.
If the start index is negative, it counts from the end of the list. If the start index is equal to the length of the list, no elements are removed and the items are appended to the end of the list. If the start index is out of bounds, a RangeError is thrown.
If deleteCount is omitted, it defaults to Infinity, meaning all elements
from the start index to the end of the list will be removed. If deleteCount
is greater than the number of elements from start to the end of the list,
it will remove all elements from start to the end of the list. If
deleteCount is 0 or negative, no elements will be removed.
If items are provided, they will be inserted starting at the start index.
Parameters
Section titled “Parameters”number
The index at which to start changing the list.
deleteCount?
Section titled “deleteCount?”number
The number of elements to remove from the list. Defaults
to Infinity
T
An optional element to add to the list at the start index.
Returns
Section titled “Returns”IterableIterator<T>
An iterable of the removed items.
Throws
Section titled “Throws”If the start index is out of bounds.
spliceAll()
Section titled “spliceAll()”spliceAll(
start,deleteCount?,items?):IterableIterator<T>
Defined in: packages/data/src/list/ilist.ts:101
Same as IList.splice, but inserts every element of items at the
start index, keeping their relative order.
Parameters
Section titled “Parameters”number
The index at which to start changing the list.
deleteCount?
Section titled “deleteCount?”number
The number of elements to remove from the list. Defaults
to Infinity
items?
Section titled “items?”readonly T[]
The elements to add to the list, beginning at the start index.
Returns
Section titled “Returns”IterableIterator<T>
An iterable of the removed items.
Throws
Section titled “Throws”If the start index is out of bounds.