ItemList Class

Contains a list of Items.

Extends

Methods

Name Description
constructor(items?: ItemDefBase[]): ItemList    
addItem(item: ItemDefBase): void    
addItems(items: ItemDefBase[]): void    

Inherited methods

Name Inherited from Description
Symbol.iterator(): IterableIterator<ItemDefBase> Array.Symbol Iterator
Symbol.unscopables(): { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean } Array.Symbol Returns an object whose properties have the value 'true'
concat(...items: ConcatArray<ItemDefBase>[]): ItemDefBase[] Array<ItemDefBase> Combines two or more arrays.
concat(...items: T | ConcatArray<T>[]): ItemDefBase[] Array<ItemDefBase> Combines two or more arrays.
copyWithin(target: number, start: number, end?: number): this Array<ItemDefBase> Returns the this object after copying a section of the array identified by start and end
entries(): IterableIterator<[number, ItemDefBase]> Array<ItemDefBase> Returns an iterable of key, value pairs for every entry in the array
every(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => unknown, thisArg?: any): boolean Array<ItemDefBase> Determines whether all the members of an array satisfy the specified test.
fill(value: ItemDefBase, start?: number, end?: number): this Array<ItemDefBase> Returns the this object after filling the section identified by start and end with value
filter<S extends ItemDefBase>(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => value is S extends ItemDefBase, thisArg?: any): S extends ItemDefBase[] Array<ItemDefBase> Returns the elements of an array that meet the condition specified in a callback function.
filter(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => unknown, thisArg?: any): ItemDefBase[] Array<ItemDefBase> Returns the elements of an array that meet the condition specified in a callback function.
find<S extends ItemDefBase>(predicate: (this: void, value: ItemDefBase, index: number, obj: ItemDefBase[]) => value is S extends ItemDefBase, thisArg?: any): S extends ItemDefBase | undefined Array<ItemDefBase> Returns the value of the first element in the array where predicate is true, and undefined
find(predicate: (value: ItemDefBase, index: number, obj: ItemDefBase[]) => unknown, thisArg?: any): ItemDefBase | undefined Array<ItemDefBase>  
findIndex(predicate: (value: ItemDefBase, index: number, obj: ItemDefBase[]) => unknown, thisArg?: any): number Array<ItemDefBase> Returns the index of the first element in the array where predicate is true, and -1
forEach(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => void, thisArg?: any): void Array<ItemDefBase> Performs the specified action for each element in an array.
includes(searchElement: ItemDefBase, fromIndex?: number): boolean Array<ItemDefBase> Determines whether an array includes a certain element, returning true or false as appropriate.
indexOf(searchElement: ItemDefBase, fromIndex?: number): number Array<ItemDefBase> Returns the index of the first occurrence of a value in an array.
join(separator?: string): string Array<ItemDefBase> Adds all the elements of an array separated by the specified separator string.
keys(): IterableIterator<number> Array<ItemDefBase> Returns an iterable of keys in the array
lastIndexOf(searchElement: ItemDefBase, fromIndex?: number): number Array<ItemDefBase> Returns the index of the last occurrence of a specified value in an array.
map<U>(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => U, thisArg?: any): U[] Array<ItemDefBase> Calls a defined callback function on each element of an array, and returns an array that contains the results.
pop(): ItemDefBase | undefined Array<ItemDefBase> Removes the last element from an array and returns it.
push(...items: ItemDefBase[]): number Array<ItemDefBase> Appends new elements to an array, and returns the new length of the array.
reduce(callbackfn: (previousValue: ItemDefBase, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => ItemDefBase): ItemDefBase Array<ItemDefBase> Calls the specified callback function for all the elements in an array.
reduce(callbackfn: (previousValue: ItemDefBase, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => ItemDefBase, initialValue: ItemDefBase): ItemDefBase Array<ItemDefBase>  
reduce<U>(callbackfn: (previousValue: U, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => U, initialValue: U): U Array<ItemDefBase> Calls the specified callback function for all the elements in an array.
reduceRight(callbackfn: (previousValue: ItemDefBase, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => ItemDefBase): ItemDefBase Array<ItemDefBase> Calls the specified callback function for all the elements in an array, in descending order.
reduceRight(callbackfn: (previousValue: ItemDefBase, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => ItemDefBase, initialValue: ItemDefBase): ItemDefBase Array<ItemDefBase>  
reduceRight<U>(callbackfn: (previousValue: U, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => U, initialValue: U): U Array<ItemDefBase> Calls the specified callback function for all the elements in an array, in descending order.
reverse(): ItemDefBase[] Array<ItemDefBase> Reverses the elements in an Array.
shift(): ItemDefBase | undefined Array<ItemDefBase> Removes the first element from an array and returns it.
slice(start?: number, end?: number): ItemDefBase[] Array<ItemDefBase> Returns a section of an array.
some(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => unknown, thisArg?: any): boolean Array<ItemDefBase> Determines whether the specified callback function returns true for any element of an array.
sort(compareFn?: (a: ItemDefBase, b: ItemDefBase) => number): this Array<ItemDefBase> Sorts an array.
splice(start: number, deleteCount?: number): ItemDefBase[] Array<ItemDefBase> Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice(start: number, deleteCount: number, ...items: ItemDefBase[]): ItemDefBase[] Array<ItemDefBase> Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
toLocaleString(): string Array<ItemDefBase> Returns a string representation of an array.
toString(): string Array<ItemDefBase> Returns a string representation of an array.
unshift(...items: ItemDefBase[]): number Array<ItemDefBase> Inserts new elements at the start of an array.
values(): IterableIterator<ItemDefBase> Array<ItemDefBase> Returns an iterable of values in the array

Properties

Name Type Description
Array Static ArrayConstructor    
items Accessor ReadOnly ItemDefBase[]    

Inherited properties

Name Type Inherited from Description
length number Array<ItemDefBase> Gets or sets the length of the array.

Defined in

Last Updated: 13 June, 2024