ListAutoDispose

Type class

A version of a List where the elements are disposed automatically when removed from the list, unless autoDispose is set to false.

@todo review

Sources

This information about ListAutoDispose is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

ListAutoDispose extends List.

ListAutoDispose is extended by ListTemplate.

Settings

ListAutoDispose does not have any settings.

Private settings

ListAutoDispose does not have any private settings.

Properties

autoDispose
#

Type boolean

Default true

Automatically disposes elements that are removed from the list.

events
#

Type EventDispatcher

Default new EventDispatcher<Events<this,
IListEvents<T>>>()

Inherited from List

length
#

Type number

Inherited from List

Number of items in list.

@readonly

values
#

Type Array

Inherited from List

An array of values in the list.

Do not use this property to add values. Rather use dedicated methods, like push(), removeIndex(), etc.

@readonly

There are 3 inherited items currently hidden from this list.

Methods

[Symbol.iterator]()

#

Returns Iterator

Inherited from List

Returns an ES6 iterator for the list.

clear()

#

Returns void

Inherited from List

Removes all items from the list.

constructor(

initial: Array

)

#

Returns ListAutoDispose

Inherited from List

Constructor

contains(

value: A

)

#

Returns boolean

Inherited from List

Checks if list contains specific item reference.

copyFrom(

source: this

)

#

Returns void

Inherited from List

Copies and adds items from abother list.

dispose()

#

Returns void

each(

f: ( value: A, index: number) => void

)

#

Returns void

Inherited from List

Calls f for each element in the list.

f should have at least one parameter defined which will get a current item, with optional second argument - index.

getIndex(

index: number

)

#

Returns A | undefined

Inherited from List

Returns an item at specified index.

hasIndex(

index: number

)

#

Returns boolean

Inherited from List

Checks if there's a value at specific index.

indexOf(

value: A

)

#

Returns number

Inherited from List

Searches the list for specific item and returns its index.

insertIndex(

index: number,
value: K

)

#

Returns K

Inherited from List

Adds an item to the list at a specific index, which pushes all the other items further down the list.

isDisposed()

#

Returns boolean

moveValue(

value: K,
toIndex?: undefined | number

)

#

Returns K

Inherited from List

Moves an item to a specific index within the list.

If the index is not specified it will move the item to the end of the list.

pop()

#

Returns Optional

Inherited from List

Returns the last item from the list, and removes it.

push(

value: K

)

#

Returns K

Inherited from List

Adds an item to the end of the list.

pushAll(

values: Array

)

#

Returns void

Inherited from List

Adds multiple items to the list.

removeIndex(

index: number

)

#

Returns A

Inherited from List

Removes a value at specific index.

removeValue(

value: A

)

#

Returns void

Inherited from List

Removes specific item from the list.

setAll(

newArray: Array

)

#

Returns void

Inherited from List

Sets multiple items to the list.

All current items are removed.

setIndex(

index: number,
value: A

)

#

Returns A

Inherited from List

Sets value at specific index.

If there's already a value at the index, it is overwritten.

shift()

#

Returns Optional

Inherited from List

Returns the first item from the list, and removes it.

swap(

a: number,
b: number

)

#

Returns void

Inherited from List

Swaps indexes of two items in the list.

unshift(

value: K

)

#

Returns K

Inherited from List

Adds an item as a first item in the list.

There are 21 inherited items currently hidden from this list.

Events

ListAutoDispose does not have any events.