ItemList Class
Contains a list of Items.
Extends
- Array<ItemDefBase>
Methods
| Name | Description | |
|---|---|---|
| constructor(items?: ItemDefBase[]): ItemList | ||
| addItem(item: ItemDefBase): void | ||
| addItems(items: ItemDefBase[]): void |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| __@iterator(): IterableIterator<ItemDefBase> | [Array.Symbol | Iterator |
| __@unscopables(): object | [Array.Symbol | Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
| concat(...items: ConcatArray<ItemDefBase>[]): ItemDefBase[] | Array | Combines two or more arrays. |
| concat(...items: T | ConcatArray<T>[]): ItemDefBase[] | Array | Combines two or more arrays. |
| copyWithin(target: number, start: number, end?: number): this | Array | Returns the this object after copying a section of the array identified by start and end to the same array starting at position target |
| entries(): IterableIterator<[number, ItemDefBase]> | Array | Returns an iterable of key, value pairs for every entry in the array |
| every(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => boolean, thisArg?: any): boolean | Array | Determines whether all the members of an array satisfy the specified test. |
| fill(value: ItemDefBase, start?: number, end?: number): this | Array | 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[]) => boolean, thisArg?: any): S extends ItemDefBase[] | Array | Returns the elements of an array that meet the condition specified in a callback function. |
| filter(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => any, thisArg?: any): ItemDefBase[] | Array | 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[]) => boolean, thisArg?: any): S extends ItemDefBase | undefined | Array | Returns the value of the first element in the array where predicate is true, and undefined otherwise. |
| find(predicate: (value: ItemDefBase, index: number, obj: ItemDefBase[]) => boolean, thisArg?: any): ItemDefBase | undefined | Array | |
| findIndex(predicate: (value: ItemDefBase, index: number, obj: ItemDefBase[]) => boolean, thisArg?: any): number | Array | Returns the index of the first element in the array where predicate is true, and -1 otherwise. |
| forEach(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => void, thisArg?: any): void | Array | Performs the specified action for each element in an array. |
| includes(searchElement: ItemDefBase, fromIndex?: number): boolean | Array | Determines whether an array includes a certain element, returning true or false as appropriate. |
| indexOf(searchElement: ItemDefBase, fromIndex?: number): number | Array | Returns the index of the first occurrence of a value in an array. |
| join(separator?: string): string | Array | Adds all the elements of an array separated by the specified separator string. |
| keys(): IterableIterator<number> | Array | Returns an iterable of keys in the array |
| lastIndexOf(searchElement: ItemDefBase, fromIndex?: number): number | Array | 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 | Calls a defined callback function on each element of an array, and returns an array that contains the results. |
| pop(): ItemDefBase | undefined | Array | Removes the last element from an array and returns it. |
| push(...items: ItemDefBase[]): number | Array | 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 | 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 | |
| reduce<U>(callbackfn: (previousValue: U, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => U, initialValue: U): U | Array | 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 | 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 | |
| reduceRight<U>(callbackfn: (previousValue: U, currentValue: ItemDefBase, currentIndex: number, array: ItemDefBase[]) => U, initialValue: U): U | Array | Calls the specified callback function for all the elements in an array, in descending order. |
| reverse(): ItemDefBase[] | Array | Reverses the elements in an Array. |
| shift(): ItemDefBase | undefined | Array | Removes the first element from an array and returns it. |
| slice(start?: number, end?: number): ItemDefBase[] | Array | Returns a section of an array. |
| some(callbackfn: (value: ItemDefBase, index: number, array: ItemDefBase[]) => boolean, thisArg?: any): boolean | Array | Determines whether the specified callback function returns true for any element of an array. |
| sort(compareFn?: (a: ItemDefBase, b: ItemDefBase) => number): this | Array | Sorts an array. |
| splice(start: number, deleteCount?: number): ItemDefBase[] | Array | 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 | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. |
| toLocaleString(): string | Array | Returns a string representation of an array. |
| toString(): string | Array | Returns a string representation of an array. |
| unshift(...items: ItemDefBase[]): number | Array | Inserts new elements at the start of an array. |
| values(): IterableIterator<ItemDefBase> | Array | 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 | Gets or sets the length of the array. |
Defined in
Last Updated: 08 January, 2020