Class BalanceArray<T>

Readonly[unscopables]

length

Static Readonly[species]

[iterator]

• "[iterator]"(): ArrayIterator<Balance<T>>

  Iterator

  Returns ArrayIterator<Balance<T>>

at

• at(index: number): undefined | Balance<T>

  Returns the item located at the specified index.

  Parameters

  • index: number

    The zero-based index of the desired code unit. A negative index will count back from the last item.

  Returns undefined | Balance<T>

copyWithin

• copyWithin(target: number, start: number, end?: number): this

  Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

  Parameters

  • target: number

    If target is negative, it is treated as length+target where length is the length of the array.

  • start: number

    If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

  • Optionalend: number

    If not specified, length of the this object is used as its default value.

  Returns this

entries

• entries(): ArrayIterator<[number, Balance<T>]>

  Returns an iterable of key, value pairs for every entry in the array

  Returns ArrayIterator<[number, Balance<T>]>

every

• every(
      predicate: (
          value: Balance,
          index: number,
          array: Balance<T>[],
      ) => unknown,
      thisArg?: any,
  ): boolean

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

  Parameters

  • predicate: (value: Balance, index: number, array: Balance<T>[]) => 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.

  • OptionalthisArg: 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

includes

• includes(searchElement: Balance, fromIndex?: number): boolean

  Determines whether an array includes a certain element, returning true or false as appropriate.

  Parameters

  • searchElement: Balance

    The element to search for.

  • OptionalfromIndex: number

    The position in this array at which to begin searching for searchElement.

  Returns boolean

indexOf

• indexOf(searchElement: Balance, fromIndex?: number): number

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

  Parameters

  • searchElement: Balance

    The value to locate in the array.

  • OptionalfromIndex: number

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

  Returns number

join

• join(separator?: string): string

  Adds all the elements of an array into a string, separated by the specified separator string.

  Parameters

  • Optionalseparator: 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

keys

• keys(): ArrayIterator<number>

  Returns an iterable of keys in the array

  Returns ArrayIterator<number>

lastIndexOf

• lastIndexOf(searchElement: Balance, fromIndex?: number): number

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

  Parameters

  • searchElement: Balance

    The value to locate in the array.

  • OptionalfromIndex: 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

pop

• pop(): undefined | Balance<T>

  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 undefined | Balance<T>

reduce

• reduce(
      callbackfn: (
          previousValue: Balance,
          currentValue: Balance,
          currentIndex: number,
          array: Balance<T>[],
      ) => Balance,
  ): Balance

  Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Parameters

  • callbackfn: (
        previousValue: Balance,
        currentValue: Balance,
        currentIndex: number,
        array: Balance<T>[],
    ) => Balance

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

  Returns Balance

• reduce(
      callbackfn: (
          previousValue: Balance,
          currentValue: Balance,
          currentIndex: number,
          array: Balance<T>[],
      ) => Balance,
      initialValue: Balance,
  ): Balance

  Parameters

  • callbackfn: (
        previousValue: Balance,
        currentValue: Balance,
        currentIndex: number,
        array: Balance<T>[],
    ) => Balance
  • initialValue: Balance

  Returns Balance

• reduce<U>(
      callbackfn: (
          previousValue: U,
          currentValue: Balance,
          currentIndex: number,
          array: Balance<T>[],
      ) => U,
      initialValue: U,
  ): U

  Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Type Parameters

  • U

  Parameters

  • callbackfn: (
        previousValue: U,
        currentValue: Balance,
        currentIndex: number,
        array: Balance<T>[],
    ) => U

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

  • initialValue: U

    If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

  Returns U

reduceRight

• reduceRight(
      callbackfn: (
          previousValue: Balance,
          currentValue: Balance,
          currentIndex: number,
          array: Balance<T>[],
      ) => Balance,
  ): Balance

  Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Parameters

  • callbackfn: (
        previousValue: Balance,
        currentValue: Balance,
        currentIndex: number,
        array: Balance<T>[],
    ) => Balance

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

  Returns Balance

• reduceRight(
      callbackfn: (
          previousValue: Balance,
          currentValue: Balance,
          currentIndex: number,
          array: Balance<T>[],
      ) => Balance,
      initialValue: Balance,
  ): Balance

  Parameters

  • callbackfn: (
        previousValue: Balance,
        currentValue: Balance,
        currentIndex: number,
        array: Balance<T>[],
    ) => Balance
  • initialValue: Balance

  Returns Balance

• reduceRight<U>(
      callbackfn: (
          previousValue: U,
          currentValue: Balance,
          currentIndex: number,
          array: Balance<T>[],
      ) => U,
      initialValue: U,
  ): U

  Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Type Parameters

  • U

  Parameters

  • callbackfn: (
        previousValue: U,
        currentValue: Balance,
        currentIndex: number,
        array: Balance<T>[],
    ) => U

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

  • initialValue: U

    If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

  Returns U

shift

• shift(): undefined | Balance<T>

  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 undefined | Balance<T>

sort

• sort(compareFn?: (a: Balance, b: Balance) => number): this

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

  Parameters

  • OptionalcompareFn: (a: Balance, b: Balance) => 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, UTF-16 code unit order.

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

  Returns this

toLocaleString

• toLocaleString(): string

  Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

  Returns string

• toLocaleString(
      locales: string | string[],
      options?: NumberFormatOptions & DateTimeFormatOptions,
  ): string

  Parameters

  • locales: string | string[]
  • Optionaloptions: NumberFormatOptions & DateTimeFormatOptions

  Returns string

toString

• toString(): string

  Returns a string representation of an array.

  Returns string

values

• values(): ArrayIterator<Balance<T>>

  Returns an iterable of values in the array

  Returns ArrayIterator<Balance<T>>

Staticfrom

• from<T>(arrayLike: ArrayLike<T>): T[]

  Creates an array from an array-like object.

  Type Parameters

  • T

  Parameters

  • arrayLike: ArrayLike<T>

    An array-like object to convert to an array.

  Returns T[]

• from<T, U>(
      arrayLike: ArrayLike<T>,
      mapfn: (v: T, k: number) => U,
      thisArg?: any,
  ): U[]

  Creates an array from an iterable object.

  Type Parameters

  • T
  • U

  Parameters

  • arrayLike: ArrayLike<T>

    An array-like object to convert to an array.

  • mapfn: (v: T, k: number) => U

    A mapping function to call on every element of the array.

  • OptionalthisArg: any

    Value of 'this' used to invoke the mapfn.

  Returns U[]

• from<T>(iterable: Iterable<T, any, any> | ArrayLike<T>): T[]

  Creates an array from an iterable object.

  Type Parameters

  • T

  Parameters

  • iterable: Iterable<T, any, any> | ArrayLike<T>

    An iterable object to convert to an array.

  Returns T[]

• from<T, U>(
      iterable: Iterable<T, any, any> | ArrayLike<T>,
      mapfn: (v: T, k: number) => U,
      thisArg?: any,
  ): U[]

  Creates an array from an iterable object.

  Type Parameters

  • T
  • U

  Parameters

  • iterable: Iterable<T, any, any> | ArrayLike<T>

    An iterable object to convert to an array.

  • mapfn: (v: T, k: number) => U

    A mapping function to call on every element of the array.

  • OptionalthisArg: any

    Value of 'this' used to invoke the mapfn.

  Returns U[]

StaticisArray

• isArray(arg: any): arg is any[]

  Parameters

  • arg: any

  Returns arg is any[]

Staticof

• of<T>(...items: T[]): T[]

  Returns a new array from a set of elements.

  Type Parameters

  • T

  Parameters

  • ...items: T[]

    A set of elements to include in the new array object.

  Returns T[]