Class Collection<CollectionItem>

Readonly items

[iterator]

• [iterator](): Iterator<CollectionItem, any, undefined>

• Returns Iterator<CollectionItem, any, undefined>

add

• add(...items): number

• Add items at the end

  Parameters

  • Rest ...items: CollectionItem[]

  Returns number

  the index of the last added item

clear

• clear(): Collection<CollectionItem>

• Clears all items

  Returns Collection<CollectionItem>

count

• count(): number

• Count the number of items

  Returns number

filter

• filter(predicate): CollectionItem[]

• The filter() method creates a new array with all elements that pass the test implemented by the provided function.

  Parameters

  • predicate: ((value, index, obj) => unknown)

    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • • (value, index, obj): unknown

      • Parameters

        • value: CollectionItem

        • index: number

        • obj: CollectionItem[]

        Returns unknown

  Returns CollectionItem[]

  CollectionItem | undefined

find

• find(predicate): undefined | CollectionItem

• Returns the value of the first element in the array where predicate is true, and undefined otherwise.

  Parameters

  • predicate: ((value, index, obj) => unknown)

    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • • (value, index, obj): unknown

      • Parameters

        • value: CollectionItem

        • index: number

        • obj: CollectionItem[]

        Returns unknown

  Returns undefined | CollectionItem

  CollectionItem | undefined

findIndex

• findIndex(predicate): number

• Returns the index of the first element in the array where predicate is true, and -1 otherwise.

  Parameters

  • predicate: ((value, index, obj) => unknown)

    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • • (value, index, obj): unknown

      • Parameters

        • value: CollectionItem

        • index: number

        • obj: CollectionItem[]

        Returns unknown

  Returns number

fire

• fire<K>(eventName, ...args): boolean

• Fire an event

  When a listener returns false this function will return false too.

  Type Parameters

  • K extends keyof CollectionEventMap<this, CollectionItem>

  Parameters

  • eventName: K

  • Rest ...args: Parameters<CollectionEventMap<Collection<CollectionItem>, CollectionItem>[K]>

  Returns boolean

first

• first(): undefined | CollectionItem

• Return first item

  Returns undefined | CollectionItem

forEach

• forEach(callbackfn, thisArg?): void

• Performs the specified action for each element in an array.

  Parameters

  • callbackfn: ((value, index, array) => void)

    A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • • (value, index, array): void

      • Parameters

        • value: CollectionItem

        • index: number

        • array: CollectionItem[]

        Returns void

  • Optional thisArg: any

    An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

  Returns void

get

• get(index): undefined | CollectionItem

• Get an item at the given index

  Parameters

  • index: number

  Returns undefined | CollectionItem

getArray

• getArray(): CollectionItem[]

• Returns CollectionItem[]

has

• has(item): boolean

• Check if the given item is present

  Parameters

  • item: CollectionItem

  Returns boolean

indexOf

• indexOf(item): number

• Find the index of an item. Returns -1 if not found.

  Parameters

  • item: CollectionItem

  Returns number

insert

• insert(index, ...items): number

• Insert items at the given index

  Parameters

  • index: number

    Use negative indexes to insert from the end. For example -1 inserts before the last item.

  • Rest ...items: CollectionItem[]

  Returns number

last

• last(): undefined | CollectionItem

• return the last item

  Returns undefined | CollectionItem

on

• on<K, L>(eventName, listener, options?): L

• Add a listener

  Type Parameters

  • K extends keyof CollectionEventMap<this, CollectionItem>

  • L extends Listener

  Parameters

  • eventName: K

  • listener: Partial<CollectionEventMap<Collection<CollectionItem>, CollectionItem>>[K]

  • Optional options: ObservableListenerOpts

  Returns L

remove

• remove(...items): void

• Remove items

  Parameters

  • Rest ...items: CollectionItem[]

  Returns void

removeAt

• removeAt(index): boolean

• Remove an item

  Parameters

  • index: number

    Item index

  Returns boolean

replace

• replace(...items): void

• Replace the collection with an array

  Parameters

  • Rest ...items: CollectionItem[]

  Returns void

un

• un<K>(eventName, listener): boolean

• Remove listener

  Type Parameters

  • K extends keyof CollectionEventMap<this, CollectionItem>

  Parameters

  • eventName: K

  • listener: Partial<CollectionEventMap<Collection<CollectionItem>, CollectionItem>>[K]

  Returns boolean