YList

Show usages

An implementation of a doubly linked list that provides direct access to the cells that store the elements.

Inheritance Hierarchy

YList

EdgeList

YNodeList

Implemented Interfaces

IList<any>

ICollection<any>

IEnumerable<any>

Remarks

The cells are represented by class ListCell.

This class supports fast access and removal operations, specifically, it is possible to remove an element in constant time (i.e. O(1)) given a reference to its list cell.

It also supports iteration over the elements either by using the list cells directly (methods firstCell/lastCell together with succCell/predCell, respectively) or by means of a cursor (cursor).

Furthermore, this list offers its own sort method. Note that this class also provides all relevant methods to use the list like a stack data type.

This implementation permits null as values. The cursor returned by instances of this class is not fail fast.

Type Details

yfiles module: algorithms
yfiles-umd modules: All layout modules, view-layout-bridge
Legacy UMD name: yfiles.algorithms.YList

Constructors

YList

()

Creates an empty doubly linked list.

YList

(c: IEnumerable<Object>)

Creates a list that is initialized with the elements provided by the given Collection object.

YList

(c: ICursor)

Creates a list that is initialized with the elements provided by the given YCursor object.

YList

(c: ICursor, predicate: IDataProvider)

Creates a list that is initialized with those elements from the given YCursor object for which the given data provider returns true upon calling its getBool method.

Parameters

options - Object
A map of options to pass to the method.

c - ICursor: A cursor providing objects that should be added to this list.
predicate - IDataProvider: A data provider that acts as a inclusion predicate for each object accessible by the given cursor.

YList

(a: Object[])

Creates a list that is initialized with the elements provided by the given array of objects.

Properties

firstCell

: ListCell

Gets the first cell of this list.

Preconditions

!isEmpty().

firstObject

: any

Gets the first element of this list.

Preconditions

!isEmpty().

isReadOnly

: boolean

Whether this collection is read-only.

Implements

ICollection

lastCell

: ListCell

Gets the last cell of this list.

Preconditions

!isEmpty().

lastObject

: any

Gets the last element of this list.

Preconditions

!isEmpty().

size

: number

Gets the number of elements in this list.

Overrides

IEnumerable.size

Methods

add

(item: Object)

addAll

(collection: ICollection<Object>) : boolean

Appends all elements provided by the given collection to this list.

Returns

↪boolean: Whether there have been elements appended.

addAll

(c: ICursor)

Appends all elements provided by the given cursor to this list.

Remarks

The cursor will be moved from its given position to the end.

Be aware that a statement like aList.append(aList.cursor()) results in an infinite recursion.

addAll

(index: number, c: ICollection<Object>) : boolean

Adds all elements provided by the given collection to this list at the specified position.

Remarks

Elements currently at that position are shifted to the right.

Parameters

options - Object
A map of options to pass to the method.

index - number: index at which the first element of the specified collection is placed
c - ICollection<Object>: the collection that contains the elements to be added

Returns

↪boolean: true if this list was changed, false otherwise

Throws

Exception({ name: 'IndexOutOfRangeError' }): if the index is out of range, that is, negative or larger than the size of this list

addFirst

(o: Object) : ListCell

Inserts the given object at the head of this list.

Returns

↪ListCell: The newly created ListCell object that stores the given object.

addFirstCell

(cell: ListCell)

Adds a formerly removed ListCell object at the head of this list.

Remarks

Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.

Parameters

options - Object
A map of options to pass to the method.

cell - ListCell: A list cell which is not part of any list.

addLast

(o: Object) : ListCell

Inserts the given object at the tail of this list.

Returns

↪ListCell: The newly created ListCell object that stores the given object.

addLastCell

(cell: ListCell)

Adds a formerly removed ListCell object at the tail of this list.

Remarks

Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.

Parameters

options - Object
A map of options to pass to the method.

cell - ListCell: A list cell which is not part of any list.

append

(items: any…) : IEnumerable<any>

Creates a wrapped enumerable that has one or several elements appended to it.

Remarks

In contrast to concat, this method will not treat the items any special if they are array-like or enumerable-like.

Parameters

options - Object
A map of options to pass to the method.

items - any: The item(s) to prepend to the enumeration

Returns

↪IEnumerable<any>: A new live view over the original enumerable that has each of the items appended to it.

Examples

const list = List.fromArray([1, 2, 3, 4])

const appendedEnumerable = list.append(5, 6)
console.log(appendedEnumerable.toArray()) // yields [1,2,3,4,5,6]

// show live updates
list.add(4.5)

console.log(appendedEnumerable.toArray()) // yields [1,2,3,4,4.5,5,6]

Overrides

IEnumerable.append

at

(index: number) : any

Returns the element at the given index in this enumerable.

Parameters

options - Object
A map of options to pass to the method.

index - number: The index of the element to return. Supports relative indexing from the end of the enumerable when passed a negative index. In other words, if a negative number is used, the returned element will be found by counting back from the end of the enumerable.

Returns

↪any: The element at the given index, or undefined if the index is not within the range of this enumerable.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4])
console.log(enumerable.at(0)) // yields 1
console.log(enumerable.at(-1)) // yields 4
console.log(enumerable.at(5)) // yields undefined

Overrides

IEnumerable.at

clear

()

Removes all elements from this list.

Implements

ICollection

concat

(elements: Object…) : IEnumerable<any>

Concatenates this enumerable with the given other elements in a new dynamic IEnumerable<T>.

Remarks

The returned enumerable is dynamic, in other words, if elements are added or removed from one of the original enumerables, the returned enumerable changes, too. If you want to store the current state of the concatenation, create a list or array of it.

Parameters

options - Object
A map of options to pass to the method.

elements - Object: Rest arguments to be appended. In case the elements are enumerable-like, too, they will be will be enumerated after the others have been enumerated. But this can also be simple objects of type T in which case they will be appended to the enumerable just like with append

Returns

↪IEnumerable<any>: A dynamic composite enumerable.

Examples

const enumerable1 = IEnumerable.from([1, 2])
const enumerable2 = IEnumerable.from([3, 4])

console.log(enumerable1.concat(enumerable2).toArray()) // yields [1,2,3,4]

// single values can be used, too
console.log(enumerable1.concat(3, 4).toArray()) // yields [1,2,3,4]

// arrays are flattened
console.log(enumerable1.concat([5, 6], [7, 8]).toArray()) // now contains [1,2,5,6,7,8]

// works with arrays and array-like collections, too
console.log(enumerable1.concat([3, 4]).toArray()) // yields [1,2,3,4]

The returned enumerable is dynamic

const list1 = List.fromArray([1, 2])
const list2 = List.fromArray([3, 4])

const result = list1.concat(list2)

console.log(result.toArray()) // yields [1,2,3,4]

list1.add(2.5)

// result changed also
console.log(result.toArray()) // yields [1,2,2.5,3,4]

list2.add(5)

// result changed also
console.log(result.toArray()) // yields [1,2,2.5,3,4,5]

Overrides

IEnumerable.concat

containsAll

(collection: ICollection<Object>) : boolean

Whether or not this list contains all the elements in the given collection.

Remarks

Equality of elements is defined by the equals method.

copyTo

(array: Object[], arrayIndex: number)

Copies the elements of this collection to an array, starting at the specified array index.

Parameters

options - Object
A map of options to pass to the method.

array - Object[]: The one-dimensional array that is the destination of the elements copied from this collection.
arrayIndex - number: The zero-based index in array at which copying begins.

cursor

() : ICursor

Returns a cursor for this list.

Remarks

All cursor operations are supported. This cursor implementation is not fail-fast and continues to work if this list is modified during the traversal as long as the current ListCell the cursor points at is this in this list or has been removed from this list but has not been added to another instance since then.

cyclicPred

(c: ListCell) : ListCell

Returns the cyclic predecessor cell of the given list cell.

Remarks

The last cell is returned as the cyclic predecessor of the first list cell.

cyclicSucc

(c: ListCell) : ListCell

Returns the cyclic successor cell of the given list cell.

Remarks

The first cell is returned as the cyclic successor of the last list cell.

distinct

(keySelector?: function(any):Object, thisArg?: Object) : IEnumerable<any>

Creates a wrapped enumerable that yields each element only once.

Remarks

To determine equality between elements, the logic of a HashMap<TKey,TValue> is used, i.e. the equals and hashCode methods are used for those elements that derive from Object.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

keySelector - function(any):Object

The optional function that determines the key to determine distinctness of the elements. If omitted, the element itself is used.

Signature Details

function(element: any) : Object

A function which creates a key for the given element.

Parameters

element - any: The element to get the key for.

Returns

Object: The key for the element.

thisArg - Object

The optional object to use for thisin the keySelector function.

Returns

↪IEnumerable<any>: A new live view over the original enumerable that yields each element with a given key at most once.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 3, 4])

const result = enumerable.distinct()

console.log(result.toArray()) // yields [1,2,3,4]

Overrides

IEnumerable.distinct

elementAt

(i: number) : any

Returns the i-th element of this list.

Preconditions

i is a valid index, i.e., i >= 0 && i < size().

Parameters

options - Object
A map of options to pass to the method.

i - number: The index of the element to return.

Returns

↪any: The element at the given index.

Throws

Exception({ name: 'ArgumentError' }): If the index is not within the range of this enumerable.

Overrides

IEnumerable.elementAt

equals

(other: Object) : boolean

Determines whether another object is equal to this one.

Parameters

options - Object
A map of options to pass to the method.

other - Object: the other object to compare for equality

Returns

↪boolean: true if other is considered equal to this instance.

every

(predicate: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : boolean

Determines whether every element of the enumerable matches the given predicate.

Parameters

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if the element matches a condition.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪boolean: true if all elements of the enumerable match the given predicate, false otherwise.

Throws

Exception({ name: 'ArgumentError' }): predicate is null.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4])

console.log(enumerable.every((item) => item < 5)) // true

console.log(enumerable.every((item) => item < 4)) // false

Overrides

IEnumerable.every

filter

(predicate: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : IEnumerable<any>

Returns a dynamic IEnumerable<T> of the elements of this enumerable which match the given predicate.

Remarks

Parameters

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if the given element should be included in the resulting enumerable.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪IEnumerable<any>: A dynamic enumerable of the elements which match the given predicate.

Examples

const enumerable = IEnumerable.from([10, 2, 30, 4, 5, 6])

const result = enumerable.filter((item) => item < 5)

console.log(result.toArray()) // yields [2,4]

The returned enumerable is dynamic

const list = List.fromArray([10, 2, 30, 4, 5, 6])

const result = list.filter((item) => item < 5)

list.add(1)

// result changed also
console.log(result.toArray()) // yields [2,4,1]

Overrides

IEnumerable.filter

find

(predicate?: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : any

Returns the first element of this enumerable, the first element of the enumerable that matches a given predicate if specified, or null if there is no such element.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if the given element should be returned.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪any: The first element of this enumerable, its first element that matches a given predicate, or null if there is no such element.

Examples

const enumerable = IEnumerable.from([10, 2, 3, 9, 5, 6])

console.log(enumerable.find((item) => item < 5)) // yields 2

// no matches with the given predicate
console.log(enumerable.find((item) => item < 2)) // yields null

Overrides

IEnumerable.find

findCell

(o: Object) : ListCell

Returns the ListCell where object o is stored.

Remarks

This operation returns null, if no such cell exists. Equality of elements is defined by the equals method. The first element in the list that matches that criteria is returned.

Returns

↪ListCell: the ListCell that contains the element or null if no such ListCell was found

findIndex

(predicate: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : number

Searches the enumerable for the first item for which predicate returns true and returns its index.

Parameters

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if an item matches the search conditions.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪number: The index of the first item for which predicate returns true or -1 if there is no such item in the enumerable.

Overrides

IEnumerable.findIndex

findLast

(predicate?: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : any

Returns the last element of this enumerable, the last element of the enumerable that matches a given predicate if specified, or null if there is no such element.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if the given element should be returned.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪any: The last element of this enumerable, its last element that matches a given predicate, or null if there is no such element.

Examples

const enumerable = IEnumerable.from([10, 2, 3, 9, 5, 6])

console.log(enumerable.findLast((item) => item < 5)) // yields 3

// no matches with the given predicate
console.log(enumerable.findLast((item) => item < 2)) // yields null

Overrides

IEnumerable.findLast

findLastIndex

(predicate: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : number

Searches the enumerable for the last item for which predicate returns true and returns its index.

Parameters

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if an item matches the search conditions.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪number: The index of the last item for which predicate returns true or -1 if there is no such item in the enumerable.

Overrides

IEnumerable.findLastIndex

first

(predicate?: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : any

Returns the first element of this enumerable or the first element of this enumerable that matches a given predicate, if specified.

Remarks

The method find serves a similar purpose as this method and is more closely modelled on the Array<T> method. Consider using that method instead.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A function which returns true if the given element should be returned.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪any: The first matching element of this enumerable.

Throws

Exception({ name: 'InvalidOperationError' }): If this enumerable does not contain a matching element.

Examples

const enumerable = IEnumerable.from([10, 2, 3, 9, 5, 6])

console.log(enumerable.first((item) => item < 5)) // yields 2

// no matches with the given predicate
console.log(enumerable.first((item) => item < 2)) // throws exception

Overrides

IEnumerable.first

firstOrDefault

(predicate?: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : any

Returns the first element of this enumerable, the first element of this enumerable that matches a given predicate, if specified, or null if there is no such element.

Remarks

This method is obsolete. Use the find or at methods instead.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if the given element should be returned.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪any: The first element of this enumerable, its first element that matches a given predicate, or null if there is no such element.

Examples

const enumerable = IEnumerable.from([10, 2, 3, 9, 5, 6])

console.log(enumerable.firstOrDefault((item) => item < 5)) // yields 2

// no matches with the given predicate
console.log(enumerable.firstOrDefault((item) => item < 2)) // yields null

Overrides

IEnumerable.firstOrDefault

flatMap

<TResult>(selector: function(any, number, IEnumerable<any>):IEnumerable<TResult>, thisArg?: Object) : IEnumerable<TResult>

Returns a flattened dynamic IEnumerable<T> of this enumerable using the given selector function which returns an enumerable for each element of this enumerable.

Remarks

Type Parameters

TResult

Parameters

options - Object
A map of options to pass to the method.

selector - function(any, number, IEnumerable<any>):IEnumerable<TResult>

A function which returns an enumerable for each element of this enumerable.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : IEnumerable<TResult>

The selector to use for the IEnumerable<T>.

A function which returns a result of type IEnumerable<T> for each element.

Parameters

element - any: The current element create a result for.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

IEnumerable<TResult>: A result of type of TResult created from the element.

thisArg - Object

The optional object to use for this in the function.

Returns

↪IEnumerable<TResult>: A flattened dynamic enumerable of the enumerables provided for each element of this enumerable.

Examples

const enumerable = IEnumerable.from([1, 2, 3])

const result = enumerable.flatMap((item) =>
  IEnumerable.from([item, item * 2])
)

console.log(result.toArray()) // yields [1,2,2,4,3,6]const enumerable = IEnumerable.from<number>([1, 2, 3])

const result = enumerable.flatMap((item) =>
  IEnumerable.from<number>([item, item * 2])
)

console.log(result.toArray()) // yields [1,2,2,4,3,6]

The returned enumerable is dynamic

const list = List.fromArray([[1], [2], [3]])

const result = list.flatMap((item) => IEnumerable.from([item[0] * 2]))

list.add([4])

// result changed also
console.log(result.toArray()) // yields [2,4,6,8]const list = List.fromArray<number[]>([[1], [2], [3]])

const result = list.flatMap((item) =>
  IEnumerable.from<number>([item[0] * 2])
)

list.add([4])

// result changed also
console.log(result.toArray()) // yields [2,4,6,8]

Overrides

IEnumerable.flatMap

forEach

(action: function(any, number, IEnumerable<any>):void, thisArg?: Object)

Iterates this enumerable and invokes the given function for each element with the element, its index, and this enumerable as arguments.

Parameters

options - Object
A map of options to pass to the method.

action - function(any, number, IEnumerable<any>):void

The function to call for each element.

Signature Details

function(element: any, index: number, source: IEnumerable<any>)

An action to execute for each element of an IEnumerable<T>.

Parameters

element - any: The current element.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

thisArg - Object

The optional object to use for this in the function.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4])

enumerable.forEach((item) => console.log(item)) // 1 2 3 4

// accessing the index
enumerable.forEach((item, index) =>
  console.log(`Item #${index} is ${item}`)
)

Overrides

IEnumerable.forEach

get

(index: number) : any

Gets the element at the specified index.

Parameters

options - Object
A map of options to pass to the method.

index - number: The zero-based index of the element to get or set.

Returns

↪any: The element at the specified index.

Implements

IList

getCell

(index: number) : ListCell

Gets the cell at the given index.

Parameters

options - Object
A map of options to pass to the method.

index - number: the zero-based index of the cell in this list.

Returns

↪ListCell: The cell.

Throws

Exception({ name: 'IndexOutOfRangeError' }): if the index is negative or greater or equal than the size

getEnumerator

() : IEnumerator<any>

Returns an enumerator that iterates through this collection.

Returns

↪IEnumerator<any>: An IEnumerator<T> that can be used to iterate through this collection.

Implements

IEnumerable

getInfo

(c: ListCell) : any

Returns the element stored in the given list cell.

groupBy

<TKey,TResult>(keySelector: function(any, number, IEnumerable<any>):TKey, resultCreator?: function(TKey, IEnumerable<any>, number):TResult, thisArg?: Object) : IEnumerable<TResult>

Groups the elements in the enumerable according to the equality of a key.

Remarks

For each element in the original enumerable the keySelector will be used to retrieve a key. All elements with the same key will be provided to the optional resultCreator function that receives both the key, and an IEnumerable<T> of the elements that match that key to create a resulting object that will be yielded by this enumerable. Note that the resulting enumerable does not necessarily preserve the order of the (first) appearance of their elements in the original sequence. The elements of each group passed to the resultCreator are in the order of their original appearance.

Type Parameters

TKey: The type of the key elements.
TResult: The type of the created elements.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

keySelector - function(any, number, IEnumerable<any>):TKey

A function which selects from each element the key.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : TKey

A function which creates a key for the given element.

Parameters

element - any: The element to get the key for.
index - number: The index of the element in the underlying .
source - IEnumerable<any>: The underlying

Returns

TKey

resultCreator - function(TKey, IEnumerable<any>, number):TResult

An optional function which transforms each group of elements and their common key into a resulting object. If omitted, the default implementation will create arrays of length 2 where the first element is the key and the second element is an IEnumerable<TSource> of the elements with the corresponding key.

Signature Details

function(key: TKey, group: IEnumerable<any>, index: number) : TResult

A function which transforms a group of elements and their common key into a resulting object.

Parameters

key - TKey: The key of the provided group.
group - IEnumerable<any>: The group of elements with the given key.
index - number: The index of the group.

Returns

TResult: A resulting object for the given group with the given key.

thisArg - Object

The optional value to use as this when executing the keySelector and resultCreator .

Returns

↪IEnumerable<TResult>: An enumeration of groups of the original enumerable.

Examples

A simple groupBy example

const enumerable = IEnumerable.from([
  { type: 'A', amount: 1 },
  { type: 'A', amount: 2 },
  { type: 'B', amount: 4 }
])

// without result creator
const groups1 = enumerable.groupBy((element) => element.type)

for (const g of groups1) {
  console.log(`Type is ${g[0]} and has ${g[1].length} members.`)
}
// Type is A and has 2 members.
// Type is B and has 1 members.

// with result creator
const groups2 = enumerable.groupBy(
  (element) => element.type,
  (type, elements) => ({
    type,
    amount: elements.sum((item) => item.amount)
  })
)

console.log(groups2.toArray()) // yields [{"type":"A","amount":4},{"type":"B","amount":4}]const enumerable = IEnumerable.from([
  { type: 'A', amount: 1 },
  { type: 'A', amount: 2 },
  { type: 'B', amount: 4 }
])

// without result creator
const groups1 = enumerable.groupBy<string, string>(
  (element) => element.type
)

for (const g of groups1) {
  console.log(`Type is ${g[0]} and has ${g[1].length} members.`)
}
// Type is A and has 2 members.
// Type is B and has 1 members.

// with result creator
const groups2 = enumerable.groupBy(
  (element) => element.type,
  (type, elements) => ({
    type,
    amount: elements!.sum((item) => item.amount)
  })
)

console.log(groups2.toArray()) // yields [{"type":"A","amount":4},{"type":"B","amount":4}]

groupBy with index

const val = IEnumerable.ofRange(1, 10)
  .groupBy(
    (value, index) => index % 2,
    (key, items, index) => [`key ${index % 2}`, items.toArray()]
  )
  .toArray()

// [
//   ["key 0",[1,3,5,7,9]],
//   ["key 1",[2,4,6,8,10]]
// ]const val = IEnumerable.ofRange(1, 10)
  .groupBy(
    (value, index) => index % 2,
    (key, items, index) => [`key ${index % 2}`, items!.toArray()]
  )
  .toArray()

// [
//   ["key 0",[1,3,5,7,9]],
//   ["key 1",[2,4,6,8,10]]
// ]

Using groupBy to create an object

const enumerable = IEnumerable.from([
  { value: 0, key: 'a' },
  { value: 1, key: 'b' },
  { value: 2, key: 'b' },
  { value: 3, key: 'a' }
])

const obj = Object.fromEntries(
  enumerable.groupBy(
    (item) => item.key,
    (key, items) => [key, items.toArray()]
  )
)

// {
//   a: [{value:0, key:a}, {value:3, key:a}],
//   b: [{value:1, key:b}, {value:2, key:b}]
// }const enumerable: IEnumerable<{ value: number; key: string }> =
  IEnumerable.from([
    { value: 0, key: 'a' },
    { value: 1, key: 'b' },
    { value: 2, key: 'b' },
    { value: 3, key: 'a' }
  ])

const obj = Object.fromEntries(
  enumerable.groupBy(
    (item) => item.key,
    (key, items) => [key, items!.toArray()]
  ) as Iterable<[unknown, unknown]>
)

// {
//   a: [{value:0, key:a}, {value:3, key:a}],
//   b: [{value:1, key:b}, {value:2, key:b}]
// }

This implementation differs from the TC39 proposal for array grouping. See the example "Using groupBy to create an object" to mimic the proposal's groupBy behavior.

Overrides

IEnumerable.groupBy

hashCode

() : number

Returns a hash code for this object.

Remarks

The hash code is a numeric value that can be used to treat this object as a key in a hash table or similar data structure.

Two objects that are considered equal must have the same hash code. However, the reverse does not hold and two objects having the same hash code don't have to be equal. Ideally, the hash code should be roughly uniformly-distributed to prevent hash tables from performing poorly. Calculating the hash code is also a potentially frequent operation and should therefore be fast.

Returns

↪number: the hash code for this object

includes

(o: Object) : boolean

Whether or not this list contains the given element.

Remarks

Equality of elements is defined by the equals method.

includes

(value: any) : boolean

Determines whether the given value is part of this enumerable.

Parameters

options - Object
A map of options to pass to the method.

value - any: The value to search for.

Returns

↪boolean: true if this enumerable contains the given value, false otherwise.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4])

console.log(enumerable.includes(2)) // true

console.log(enumerable.includes(5)) // false

Defined in

IEnumerable

indexOf

(item: any, fromIndex?: number) : number

The index of the given item in the enumerable.

Parameters

options - Object
A map of options to pass to the method.

item - any: The item to search for.
fromIndex - number

Returns

↪number: The index of the given item in the enumerable. -1 if the item is not in the enumerable.

Overrides

IEnumerable.indexOf

insert

(index: number, element: Object)

Inserts the given element into this list at the given index.

Remarks

The (newly created) list cell that stores the object is inserted right before the given index.

Parameters

options - Object
A map of options to pass to the method.

index - number: The index that specifies the insertion position.
element - Object: The element to insert.

insertAfter

(o: Object, refCell: ListCell) : ListCell

Inserts the given object into this list with respect to a given reference list cell.

Remarks

The (newly created) list cell that stores the object is inserted right after the reference list cell refCell.

If refCell == null, the given object is inserted at the head of the list.

Preconditions

refCell must be part of this list.

Parameters

options - Object
A map of options to pass to the method.

o - Object: The object to be inserted.
refCell - ListCell: The list cell used to reference the position.

Returns

↪ListCell: The newly created ListCell object that stores object o.

insertBefore

(o: Object, refCell: ListCell) : ListCell

Inserts the given object into this list with respect to a given reference list cell.

Remarks

The (newly created) list cell that stores the object is inserted right before the reference list cell refCell.

If refCell == null, the given object is appended to the list.

Preconditions

refCell must be part of this list.

Parameters

options - Object
A map of options to pass to the method.

o - Object: The object to be inserted.
refCell - ListCell: The list cell used to reference the position.

Returns

↪ListCell: The newly created ListCell object that stores object o.

insertCellAfter

(cellToInsert: ListCell, refCell: ListCell)

Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.

Remarks

The ListCell object is inserted right after the reference list cell refCell.

Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.

Preconditions

refCell must be part of this list.

Parameters

options - Object
A map of options to pass to the method.

cellToInsert - ListCell: A list cell which is not part of any list.
refCell - ListCell: The list cell used to reference the position.

insertCellBefore

(cellToInsert: ListCell, refCell: ListCell)

Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.

Remarks

The ListCell object is inserted right before the reference list cell refCell.

Attention: If the ListCell object is still part of any list, then that list will be corrupted afterwards.

Preconditions

refCell must be part of this list.

Parameters

options - Object
A map of options to pass to the method.

cellToInsert - ListCell: A list cell which is not part of any list.
refCell - ListCell: The list cell used to reference the position.

isEmpty

() : boolean

Checks whether this list contains elements.

last

(predicate?: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : any

Returns the last element of this enumerable or the last element of this enumerable that matches a given predicate, if specified.

Remarks

The method findLast serves a similar purpose as this method and is more closely modelled on the Array.findLast" method. Consider using that method instead.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A function which returns true if the given element should be returned.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪any: The last element of this enumerable.

Throws

Exception({ name: 'InvalidOperationError' }): If the enumerable is empty.

Examples

const enumerable1 = IEnumerable.from([1, 2, 3, 4])
console.log(enumerable1.last()) // yields 4

// if the enumerable is empty then an exception will be thrown
const enumerable2 = IEnumerable.from([])
console.log(enumerable2.last()) // throws exception

Overrides

IEnumerable.last

lastIndexOf

(o: Object) : number

Returns the zero-based index of the last occurence of the given element in this list.

Parameters

options - Object
A map of options to pass to the method.

o - Object: The element.

Returns

↪number: The zero-based index of the last occurence of the given element in this list.

lastOrDefault

(predicate?: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : any

Returns the last element of this enumerable, the last element of this enumerable that matches a given predicate, if specified, or null if there is no such element.

Remarks

This method is obsolete. Use the findLast or at methods instead.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A predicate function which returns true if the given element should be returned.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪any: The last element of the enumerable or null.

Examples

const enumerable1 = IEnumerable.from([1, 2, 3, 4])
console.log(enumerable1.lastOrDefault()) // yields 4

// if the enumerable is empty then null will be returned
const enumerable2 = IEnumerable.from([])
console.log(enumerable2.lastOrDefault()) // yields null

Overrides

IEnumerable.lastOrDefault

map

<TResult>(selector: function(any, number, IEnumerable<any>):TResult, thisArg?: Object) : IEnumerable<TResult>

Returns a dynamic IEnumerable<T> of this enumerable using the given selector function which returns a new object for each element of this enumerable.

Remarks

Type Parameters

TResult: The type of the mapped elements.

Parameters

options - Object
A map of options to pass to the method.

selector - function(any, number, IEnumerable<any>):TResult

A function which converts each element into a new element of the type TResult.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : TResult

The selector to use for the IEnumerable<T>.

A function which returns a result of type TResult for each element.

Parameters

element - any: The current element create a result for.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

TResult: A result of type TResult created from the element.

thisArg - Object

The optional value to use as this when executing the selector.

Returns

↪IEnumerable<TResult>: A dynamic enumerable of the results of the provided function.

Examples

const enumerable = IEnumerable.from([1, 2, 3])

const result = enumerable.map((item) => item * 2)

console.log(result.toArray()) // yields [2, 4, 6]

// with index
const result2 = enumerable.map((item, index) => item * index)

console.log(result2.toArray()) // yields [0, 2, 6]

// with index and enumerable
const result3 = enumerable.map(
  (item, index, enumerable) =>
    `Item no ${index} of ${enumerable.size} is ${item}`
)

console.log(result3.toArray())
// ["Item no 0 of 3 is 1","Item no 1 of 3 is 2","Item no 2 of 3 is 3"]const enumerable = IEnumerable.from([1, 2, 3])

const result = enumerable.map((item) => item * 2)

console.log(result.toArray()) // yields [2, 4, 6]

// with index
const result2 = enumerable.map((item, index) => item * index)

console.log(result2.toArray()) // yields [0, 2, 6]

// with index and enumerable
const result3 = enumerable.map(
  (item, index, enumerable) =>
    `Item no ${index} of ${enumerable!.size} is ${item}`
)

console.log(result3.toArray())
// ["Item no 0 of 3 is 1","Item no 1 of 3 is 2","Item no 2 of 3 is 3"]

The returned enumerable is dynamic

const list = List.fromArray([1, 2, 3])

const result = list.map((item) => item * 2)

list.add(4)

// result changed also
console.log(result.toArray()) // yields [2,4,6,8]

Overrides

IEnumerable.map

ofType

<TResult>(resultType: Class) : IEnumerable<TResult>

Converts this untyped enumerable into an enumerable with the given type.

Remarks

The source enumerable may contain elements which are not of the given type. Those elements will not be contained in the returned enumerable.

Type Parameters

TResult

Returns

↪IEnumerable<TResult>: A typed enumerable.

Overrides

IEnumerable.ofType

orderBy

<TKey>(keySelector?: function(any):TKey, comparer?: function(TKey, TKey):number, thisArg?: Object) : IEnumerable<any>

Yields an ordered enumerable of the elements given a key selection function and optional comparison function and creates a ordered view of the enumerable.

Remarks

The sorting will happen each time the enumerable is enumerated.

Type Parameters

TKey

ParametersOptions Overload

options - Object
A map of options to pass to the method.

keySelector - function(any):TKey

The function that determines the key for sorting the elements. If omitted, the element itself is used.

Signature Details

function(element: any) : TKey

A function which creates a key for the given element.

Parameters

element - any: The element to get the key for.

Returns

TKey: The key for the element.

comparer - function(TKey, TKey):number

A function with the signature function(key1, key2):Number which is used for the sort operation to compare the key elements in the enumerable. May be omitted.

Signature Details

function(value1: TKey, value2: TKey) : number

Compares the given values.

Parameters

value1 - TKey: The first value to compare.
value2 - TKey: The second value to compare.

Returns

number: A value less than 0 if value 1 is smaller than value2, 0 if both values are equal, greater than 0 otherwise.

thisArg - Object

Returns

↪IEnumerable<any>: An enumeration of groups of the original enumerable.

Examples

const enumerable = IEnumerable.from([
  { type: 'name-6', rank: 8 },
  { type: 'name-23', rank: 4 },
  { type: 'name-3', rank: 5 }
])

// order by the elements' rank, without a comparer function
const sortedEnumerable1 = enumerable.orderBy((entry) => entry.rank)

console.log(sortedEnumerable1.toArray())
// [{ "type": "name-23", "rank": 4 }, { "type": "name-3", "rank": 5 }, { "type": "name-6", "rank": 8 }]

// order by the elements' type using numeric collation to get a more "natural" order, with a comparer function
const collator = new Intl.Collator(undefined, {
  numeric: true,
  sensitivity: 'base'
})
const sortedEnumerable2 = enumerable.orderBy(
  (entry) => entry.type,
  collator.compare
)

console.log(sortedEnumerable2.toArray())
// [{ "type": "name-3", "rank": 5 }, { "type": "name-6", "rank": 8 },{ "type": "name-23", "rank": 4 }]

Overrides

IEnumerable.orderBy

orderByDescending

<TKey>(keySelector?: function(any):TKey, comparer?: function(TKey, TKey):number, thisArg?: Object) : IEnumerable<any>

Yields an ordered enumerable of the elements given a key selection function and optional comparison function and creates a ordered view of the enumerable where the elements are yielded in descending order.

Remarks

The sorting will happen each time the enumerable is enumerated.

Type Parameters

TKey

ParametersOptions Overload

options - Object
A map of options to pass to the method.

keySelector - function(any):TKey

The function that determines the key for sorting the elements. If omitted, the element itself is used.

Signature Details

function(element: any) : TKey

A function which creates a key for the given element.

Parameters

element - any: The element to get the key for.

Returns

TKey: The key for the element.

comparer - function(TKey, TKey):number

A function with the signature function(key1, key2):Number which is used for the sort operation to compare the key elements in the enumerable. May be omitted.

Signature Details

function(value1: TKey, value2: TKey) : number

Compares the given values.

Parameters

value1 - TKey: The first value to compare.
value2 - TKey: The second value to compare.

Returns

number: A value less than 0 if value 1 is smaller than value2, 0 if both values are equal, greater than 0 otherwise.

thisArg - Object

Returns

↪IEnumerable<any>: An enumeration of groups of the original enumerable.

Examples

const enumerable = IEnumerable.from([
  { type: 'A' },
  { type: 'B' },
  { type: 'C' },
  { type: 'D' }
])

// order by the elements' types, without a comparer function
const sortedEnumerable1 = enumerable.orderByDescending(
  (entry) => entry.type
)

console.log(sortedEnumerable1.toArray())
// [{ "type": "D" }, { "type": "C" }, { "type": "B" }, { "type": "A" }]

Overrides

IEnumerable.orderByDescending

peek

() : any

Equivalent to firstObject.

pop

() : any

Removes and returns the last value in this list.

Remarks

This function mimics the JavaScript Array.pop() function and returns undefined if the list is empty.

Returns

↪any: The removed value. undefined if the list was empty.

Defined in

IList

predCell

(c: ListCell) : ListCell

Returns the predecessor cell of the given list cell.

prepend

(items: any…) : IEnumerable<any>

Creates a wrapped enumerable that has on or several elements prepended to it.

Parameters

options - Object
A map of options to pass to the method.

items - any: The item(s) to prepend to the enumeration

Returns

↪IEnumerable<any>: A new live view over the original enumerable that has items prepended to it.

Examples

const enumerable1 = IEnumerable.from([1, 2, 3, 4])
console.log(enumerable1.prepend(0).toArray()) // yields [0,1,2,3,4]

// more than one value can be used too
const enumerable2 = IEnumerable.from([3, 4, 5, 6])
console.log(enumerable2.prepend(1, 2).toArray()) // yields [1,2,3,4,5,6]

Overrides

IEnumerable.prepend

push

(values: any…) : number

Adds one or more elements to this list and returns the new length.

Remarks

This function mimics the JavaScript Array.push() function.

Parameters

options - Object
A map of options to pass to the method.

values - any: The values to append to the list.

Returns

↪number: The new length of the list.

Defined in

IList

reduce

<TAccumulate>(accumulator: function(TAccumulate, any, number, IEnumerable<any>):TAccumulate, initialValue: TAccumulate) : TAccumulate

Applies the accumulator function to this elements of this enumerable.

Type Parameters

TAccumulate: The type of the accumulated value.

Parameters

options - Object
A map of options to pass to the method.

accumulator - function(TAccumulate, any, number, IEnumerable<any>):TAccumulate

A function which "adds" (accumulates) a value depending on the element and index to the initial value and returns the result.

Signature Details

function(total: TAccumulate, element: any, index: number, source: IEnumerable<any>) : TAccumulate

The accumulator to use for the IEnumerable<T>.

A function which returns a result of type TAccumulate as an accumulation of total and element.

Parameters

total - TAccumulate: The previously returned value of the function.
element - any: The current element to accumulate.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

TAccumulate: A result of type TAccumulate created from the element.

initialValue - TAccumulate

The initial value for the accumulator. Omit/use the reduce overload if you don't want to specify an initial value.

Returns

↪TAccumulate: The result of the accumulation.

Examples

The returned enumerable is dynamic

const enumerable = IEnumerable.from([1, 2, 3, 4, 5])

const result = enumerable.reduce(
  (accumulator, currentValue) => Math.max(accumulator, currentValue),
  0
)

console.log(result) // expected output: 5

Overrides

IEnumerable.reduce(yfiles.collections.Accumulator,TAccumulate)

reduce

(accumulator: function(any, any, number, IEnumerable<any>):any) : any

Applies the accumulator function to this elements of this enumerable.

Parameters

options - Object
A map of options to pass to the method.

accumulator - function(any, any, number, IEnumerable<any>):any

A function which "adds" (accumulates) a value depending on the element and index to the initial value and returns the result.

Signature Details

function(total: any, element: any, index: number, source: IEnumerable<any>) : any

The accumulator to use for the IEnumerable<T>.

A function which returns a result of type TAccumulate as an accumulation of total and element.

Parameters

total - any: The previously returned value of the function.
element - any: The current element to accumulate.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

any: A result of type TAccumulate created from the element.

Returns

↪any: The result of the accumulation.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4, 5])

const result = enumerable.reduce(
  (accumulator, currentValue) => accumulator + currentValue
)

console.log(result) // expected output: 15

Overrides

IEnumerable.reduce(yfiles.collections.Accumulator)

reduceRight

<TAccumulate>(accumulator: function(TAccumulate, any, number, IEnumerable<any>):TAccumulate, initialValue: TAccumulate) : TAccumulate

Applies the accumulator function to this elements of this enumerable in reverse order.

Type Parameters

TAccumulate: The type of the accumulated value.

Parameters

options - Object
A map of options to pass to the method.

accumulator - function(TAccumulate, any, number, IEnumerable<any>):TAccumulate

A function which "adds" (accumulates) a value depending on the element and index to the seed value and returns the result.

Signature Details

function(total: TAccumulate, element: any, index: number, source: IEnumerable<any>) : TAccumulate

The accumulator to use for the IEnumerable<T>.

A function which returns a result of type TAccumulate as an accumulation of total and element.

Parameters

total - TAccumulate: The previously returned value of the function.
element - any: The current element to accumulate.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

TAccumulate: A result of type TAccumulate created from the element.

initialValue - TAccumulate

The initial value for the accumulator. Omit/use the reduceRight overload if you don't want to specify an initial value.

Returns

↪TAccumulate: The final value of the accumulation.

Examples

The returned enumerable is dynamic

const enumerable = IEnumerable.from(['a', 'b', 'c', 'd'])

const result = enumerable.reduceRight(
  (accumulator, currentValue) => currentValue + accumulator,
  '.'
)

console.log(result) // yields 'abcd.'

Overrides

IEnumerable.reduceRight(yfiles.collections.Accumulator,TAccumulate)

reduceRight

(accumulator: function(any, any, number, IEnumerable<any>):any) : any

Applies the accumulator function to this elements of this enumerable in reverse order.

Parameters

options - Object
A map of options to pass to the method.

accumulator - function(any, any, number, IEnumerable<any>):any

A function which "adds" (accumulates) a value depending on the element and index to the seed value and returns the result.

Signature Details

function(total: any, element: any, index: number, source: IEnumerable<any>) : any

The accumulator to use for the IEnumerable<T>.

A function which returns a result of type TAccumulate as an accumulation of total and element.

Parameters

total - any: The previously returned value of the function.
element - any: The current element to accumulate.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

any: A result of type TAccumulate created from the element.

Returns

↪any: The result of the accumulation.

Examples

const enumerable = IEnumerable.from([
  [0, 1],
  [2, 3],
  [4, 5]
])

const result = enumerable.reduceRight((accumulator, currentValue) =>
  accumulator.concat(currentValue)
)

console.log(result) // yields [4,5,2,3,0,1]

Overrides

IEnumerable.reduceRight(yfiles.collections.Accumulator)

remove

(o: Object) : boolean

Removes the given object from this list.

Remarks

Only the first element for which equality to o holds gets removed.

Complexity

O(size())

removeAll

(collection: ICollection<Object>) : boolean

Removes the given collection of objects from this list.

Returns

↪boolean: Whether there have been elements removed.

removeAt

(index: number)

Removes the element at the position specified by the given index.

Parameters

options - Object
A map of options to pass to the method.

index - number: The index that specifies the element to remove.

Implements

IList

removeAtCursor

(c: ICursor) : any

Removes the element pointed to by the given YCursor object.

Preconditions

The given cursor has been created by a call to this list's method and the element pointed to by it is contained in this list.

Returns

↪any: The removed element.

removeCell

(c: ListCell) : any

Removes the given list cell, and hence the element stored in it, from this list.

Complexity

O(1)

Preconditions

The given list cell is part of this list.

Returns

↪any: The element that is stored in the removed cell.

retainAll

(collection: ICollection<Object>) : boolean

Retains only those elements in this list which are contained in the given collection.

Complexity

This operation has running time O(max(m, n)), were m and n are the sizes of this list and the given collection, respectively.

Returns

↪boolean: Whether there have been elements removed.

reverse

()

Reverses the sequence of elements in this list.

set

(index: number, value: Object)

Sets the element at the specified index.

Parameters

options - Object
A map of options to pass to the method.

index - number: The zero-based index of the element to get or set.
value - Object: The element at the specified index.

setInfo

(c: ListCell, value: Object)

Updates the element stored in the given list cell with the given object.

shift

() : any

Removes and returns the first value in this list.

Remarks

This function mimics the JavaScript Array.shift() function and returns undefined if the list is empty.

Returns

↪any: The removed value. undefined if the list was empty.

Defined in

IList

skip

(amount: number) : IEnumerable<any>

Creates a wrapped view of an enumerable which skips the given amount of elements.

Parameters

options - Object
A map of options to pass to the method.

amount - number: The number of elements to skip at the beginning.

Returns

↪IEnumerable<any>: A new live view over the original enumerable that skips amount elements.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4, 5, 6, 7])

const result = enumerable.skip(3)

console.log(result.toArray()) // yields [4,5,6,7]

Overrides

IEnumerable.skip

skipWhile

(predicate: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : IEnumerable<any>

Creates a wrapped view of an enumerable which skips a number of elements at the beginning while the given predicate yields true.

Remarks

While the predicate yields true for the elements of the original enumerable, the elements are skipped. The new enumeration will start with the first element for which the predicate yields false. All subsequent elements will be yielded.

Parameters

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

The predicate function that determines what elements should be skipped. While the predicate yields true for the provided item, the element will not be yielded.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for thisin the predicate function.

Returns

↪IEnumerable<any>: A new live view over the original enumerable that discards elements at the beginnging of the original enumeration while the predicate yields true.

Examples

const enumerable = IEnumerable.from([
  'a',
  'b',
  'c',
  'd',
  'a',
  'b',
  'c',
  'd'
])

const result = enumerable.skipWhile(
  (element) => element.charCodeAt(0) < 'c'.charCodeAt(0)
)

console.log(result.toArray()) // yields ["c", "d", "a", "b", "c", "d"]

Overrides

IEnumerable.skipWhile

some

(predicate?: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : boolean

Determines whether this enumerable contains any elements matching the given predicate.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A function which returns true if the element matches a condition.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for this in the function.

Returns

↪boolean: Whether this enumerable contains any elements matching the given predicate.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4, 5, 6, 7])

const result = enumerable.some((item) => item % 2 === 0)

console.log(result) // true

Overrides

IEnumerable.some

sort

(comparer: IComparer<Object>)

Sorts the elements in this list according to the given comparator.

Remarks

NOTE: The elements will be assigned to different list cells by this method.

Complexity

O(size() * log(size()))

sort

()

Sorts the elements in this list into ascending order, according to their natural ordering.

Remarks

All elements must implement the IComparable interface. Furthermore, all elements in this list must be mutually comparable (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in this list).

NOTE: The elements will be assigned to different list cells by this method.

Complexity

O(size() * log(size()))

splice

(list: YList)

Transfers the contents of the given list to the end of this list.

Remarks

The given list will be empty after this operation.

Note that this operation transfers the list cells of the given list to this list. No new list cells are created by this operation.

Complexity

O(1)

succCell

(c: ListCell) : ListCell

Returns the successor cell of the given list cell.

sum

(selector: function(any, number, IEnumerable<any>):number, thisArg?: Object) : number

Calculates the sum of the elements of this enumerable.

Parameters

options - Object
A map of options to pass to the method.

selector - function(any, number, IEnumerable<any>):number

A function which returns a numeric value for the given element.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : number

The selector to use for the IEnumerable<T>.

A function which returns a result of type TResult for each element.

Parameters

element - any: The current element create a result for.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

number: A result of type TResult created from the element.

thisArg - Object

The optional object to use for this in the function.

Returns

↪number: The sum of the elements of the enumerable.

Examples

const enumerable = IEnumerable.from([
  { type: 'A', amount: 3 },
  { type: 'B', amount: 2 },
  { type: 'C', amount: 2 },
  { type: 'D', amount: 5 }
])

const result = enumerable.sum((element) => element.amount)

console.log(result) // yields 12

Overrides

IEnumerable.sum

take

(count: number) : IEnumerable<any>

Creates a dynamic view of this enumerable with the given number of elements taken from the start or end of this enumerable.

Parameters

options - Object
A map of options to pass to the method.

count - number: The number of elements in the created enumerable. If the number is positive, the elements are taken from the beginning, otherwise, the elements are taken from the end.

Returns

↪IEnumerable<any>: A dynamic iew of this enumerable with the given number of elements.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4, 5, 6, 7])

// positive parameter means taking elements from the beginning of the enumerable
console.log(enumerable.take(2).toArray()) // yields [1,2]

// negative parameter means taking elements from the end of the enumerable
console.log(enumerable.take(-2).toArray()) // yields [6,7]

Overrides

IEnumerable.take

takeWhile

(predicate: function(any, number, IEnumerable<any>):boolean, thisArg?: Object) : IEnumerable<any>

Returns a dynamic IEnumerable<T> that contains the elements from this enumerable as long as the given predicate is true.

Remarks

Parameters

options - Object
A map of options to pass to the method.

predicate - function(any, number, IEnumerable<any>):boolean

A function which returns true as long as the elements should be added to the returned enumerable.

Signature Details

function(element: any, index: number, source: IEnumerable<any>) : boolean

The predicate to use for IEnumerable<T>.

Parameters

element - any: The current element to test.
index - number: The element's index in the
source - IEnumerable<any>: The enumerable this function is called upon.

Returns

boolean: true if the item matches the condition.

thisArg - Object

The optional object to use for thisin the function.

Returns

↪IEnumerable<any>: A dynamic enumerable that is a subset of the original enumerable.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 30, 4, 5])

const result = enumerable.takeWhile((item) => item < 5)

console.log(result.toArray()) // yields [1,2,3]

Overrides

IEnumerable.takeWhile

toArray

() : any

Returns an array representation of this list.

Returns

↪any[]: An array with the elements of this enumerable.

Overrides

IEnumerable.toArray

toList

() : List<any>

Creates a List<T> with the values of this enumerable.

Returns

↪List<any>: A List<T> of the elements of this enumerable.

Overrides

IEnumerable.toList

toReversed

() : IEnumerable<any>

Returns an dynamic enumerable which contains the elements of this enumerable in reverse order.

Remarks

Returns

↪IEnumerable<any>: A dynamic enumerable which contains the elements of the original enumerable in reverse order.

Examples

const enumerable = IEnumerable.from([1, 2, 3, 4, 5])

const result = enumerable.toReversed()

console.log(result.toArray()) // yields [5,4,3,2,1]

The returned enumerable is dynamic

const list = List.fromArray([1, 2, 3, 4, 5])

const result = list.toReversed()

list.add(0)

// result changed also
console.log(result.toArray()) // yields [0,5,4,3,2,1]

Overrides

IEnumerable.toReversed

toString

() : string

Returns a string representation of this list.

unshift

(values: any…) : number

Adds one or more elements to the beginning of this list and returns the new length.

Remarks

This function mimics the JavaScript Array.unshift() function.

Parameters

options - Object
A map of options to pass to the method.

values - any: The values to prepend to this list. The first argument will become the new first element in the list

Returns

↪number: The new length of the list.

Defined in

IList

YList

Remarks

Type Details

See Also

Constructors

YList

YList

YList

YList

Parameters

YList

Properties

firstCell

Preconditions

firstObject

Preconditions

isReadOnly

Implements

lastCell

Preconditions

lastObject

Preconditions

size

Overrides

Methods

add

addAll

Returns

addAll

Remarks

addAll

Remarks

Parameters

Returns

Throws

addFirst

Returns

addFirstCell

Remarks

Parameters

addLast

Returns

addLastCell

Remarks

Parameters

append

Remarks

Parameters

Returns

Examples

See Also

Overrides

at

Parameters

Returns

Examples

Overrides

clear

Implements

concat

Remarks

Parameters

Returns

Examples

See Also

Overrides

containsAll

Remarks

copyTo

Parameters

cursor

Remarks

cyclicPred

Remarks

cyclicSucc

Remarks

distinct

Remarks

ParametersOptions Overload

Signature Details