Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AxVeProInstances

Hierarchy

Indexable

[n: number]: AxVeProInstance

Index

Properties

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Methods

concat

  • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

    Parameters

    • Rest ...items: ConcatArray<AxVeProInstance>[]

      Additional arrays and/or items to add to the end of the array.

    Returns AxVeProInstance[]

  • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional arrays and/or items to add to the end of the array.

    Returns AxVeProInstance[]

every

  • Determines whether all the members of an array satisfy the specified test.

    Type parameters

    Parameters

    • predicate: (value: AxVeProInstance, index: number, array: AxVeProInstance[]) => value is S

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    • Optional thisArg: any

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

    Returns this is S[]

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: AxVeProInstance, index: number, array: AxVeProInstance[]) => unknown

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    • Optional thisArg: any

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

    Returns boolean

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • predicate: (value: AxVeProInstance, index: number, array: AxVeProInstance[]) => value is S

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

    • Optional thisArg: any

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

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: (value: AxVeProInstance, index: number, array: AxVeProInstance[]) => unknown

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

    • Optional thisArg: any

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

    Returns AxVeProInstance[]

forEach

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

    Parameters

    • callbackfn: (value: AxVeProInstance, index: number, array: AxVeProInstance[]) => void

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

    • 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

getByName

  • Parameters

    • name: string

    Returns AxVeProInstance

indexOf

  • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

    Parameters

    • searchElement: AxVeProInstance

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

invalidate

join

  • join(separator?: string): string
  • Adds all the elements of an array into a string, separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

    Returns string

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

    Parameters

    • searchElement: AxVeProInstance

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: (value: AxVeProInstance, index: number, array: AxVeProInstance[]) => U

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

    • 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 U[]

pop

  • Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns AxVeProInstance | undefined

push

  • Appends new elements to the end of an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

shift

  • Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

    Returns AxVeProInstance | undefined

slice

  • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

    Parameters

    • Optional start: number

      The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

    • Optional end: number

      The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

    Returns AxVeProInstance[]

some

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: (value: AxVeProInstance, index: number, array: AxVeProInstance[]) => unknown

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

    • Optional thisArg: any

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

    Returns boolean

sort

  • Sorts an array in place. This method mutates the array and returns a reference to the same array.

    Parameters

    • Optional compareFn: (a: AxVeProInstance, b: AxVeProInstance) => number

      Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      [11,2,22,1].sort((a, b) => a - b)

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns AxVeProInstance[]

    An array containing the elements that were deleted.

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AxVeProInstance[]

      Elements to insert into the array in place of the deleted elements.

    Returns AxVeProInstance[]

    An array containing the elements that were deleted.

toLocaleString

  • toLocaleString(): string

toString

  • toString(): string

unshift

  • Inserts new elements at the start of an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AxVeProInstance[]

      Elements to insert at the start of the array.

    Returns number

Generated using TypeDoc