X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=057d4d1f1be2ea32f102e1bc01d07e570003c579;hb=67de15a041152a973334839ad2c73284b1b3cbb3;hp=94bb117e1ce2d12cd4996bef68f53e718018d77c;hpb=56960396878dec81e3ebeea5b76387efca8cc2dc;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 94bb117e..057d4d1f 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,4 +1,4 @@ -CircularArray | poolifier
+CircularArray | poolifier
+

Returns CircularArray<T>

+
  • Defined in src/circular-array.ts:11
  • Properties

    -
    +
    -
    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        at?: any;
        concat?: any;
        copyWithin?: any;
        entries?: any;
        every?: any;
        fill?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        flat?: any;
        flatMap?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        pop?: any;
        push?: any;
        reduce?: any;
        reduceRight?: any;
        reverse?: any;
        shift?: any;
        slice?: any;
        some?: any;
        sort?: any;
        splice?: any;
        toLocaleString?: any;
        toString?: any;
        unshift?: any;
        values?: any;
    }
    +
    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        at?: any;
        concat?: any;
        copyWithin?: any;
        entries?: any;
        every?: any;
        fill?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        flat?: any;
        flatMap?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        pop?: any;
        push?: any;
        reduce?: any;
        reduceRight?: any;
        reverse?: any;
        shift?: any;
        slice?: any;
        some?: any;
        sort?: any;
        splice?: any;
        toLocaleString?: any;
        toString?: any;
        unshift?: any;
        values?: any;
    }

    Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    @@ -125,53 +125,53 @@ when they will be absent when used in a 'with' statement.

    Type declaration

    • -
      Optional Readonly [unscopables]?: boolean
      +
      Optional Readonly [unscopables]?: boolean

      Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    • -
      Optional length?: boolean
      +
      Optional length?: boolean

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

    -
    +
    -
    length: number
    +
    length: number

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

    -
    +
    -
    size: number
    -
    +
  • Defined in src/circular-array.ts:9
  • +
    -
    [species]: ArrayConstructor

    Methods

    -
    +
    -
      - +
        +
      • Iterator

        -

        Returns IterableIterator<T>

    -
    +
    -
      - +
        +
      • Returns the item located at the specified index.

        @@ -179,44 +179,46 @@ when they will be absent when used in a 'with' statement.

        Parameters

        • -
          index: number
          +
          index: number

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

        -

        Returns undefined | T

    -
    +
    -
      - +
        +
      • Parameters

        • -
          size: number
        +
        size: number

      Returns void

    -
    +
  • Defined in src/circular-array.ts:88
  • +
    -
    -
    +
  • Defined in src/circular-array.ts:39
  • +
    -
      - +
        +
      • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

        @@ -225,88 +227,88 @@ to the same array starting at position target

        Parameters

        • -
          target: number
          +
          target: number

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

        • -
          start: number
          +
          start: number

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

        • -
          Optional end: number
          +
          Optional end: number

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

        -

        Returns CircularArray<T>

    -
    +
    -
    -
    +
  • Defined in src/circular-array.ts:80
  • +
    -
      - +
        +
      • Returns an iterable of key, value pairs for every entry in the array

        -

        Returns IterableIterator<[number, T]>

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

        -
        +

        Type Parameters

        -
          +
          • -

            S

        +

        S

    Parameters

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

      • -
          -
        • (value: T, index: number, array: T[]): value is S
        • +
            +
          • (value, index, array): value is S
          • Parameters

            • -
              value: T
            • +
              value: T
            • -
              index: number
            • +
              index: number
            • -
              array: T[]
            -

            Returns value is S

      • +
        array: T[]
    +

    Returns value is S

  • -
    Optional thisArg: any
    +
    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[]

    -
    +
    -
      - +
        +
      • Changes all array elements from start to end index to a static value and returns the modified array

        @@ -354,66 +356,66 @@ If thisArg is omitted, undefined is used as the this value.

        Parameters

        • -
          value: T
          +
          value: T

          value to fill array section with

        • -
          Optional start: number
          +
          Optional start: number

          index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        • -
          Optional end: number
          +
          Optional end: number

          index to stop filling the array at. If end is negative, it is treated as length+end.

        -

        Returns CircularArray<T>

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

        -
        +

        Type Parameters

        -
          +
          • -

            S

        +

        S

    Parameters

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

      • -
          -
        • (value: T, index: number, array: T[]): value is S
        • +
            +
          • (value, index, array): value is S
          • Parameters

            • -
              value: T
            • +
              value: T
            • -
              index: number
            • +
              index: number
            • -
              array: T[]
            -

            Returns value is S

      • +
        array: T[]
    +

    Returns value is S

  • -
    Optional thisArg: any
    +
    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 value of the first element in the array where predicate is true, and undefined otherwise.

        -
        +

        Type Parameters

        -
          +
          • -

            S

        +

        S

    Parameters

    • -
      predicate: ((value: T, index: number, obj: T[]) => value is S)
      +
      predicate: ((value, index, obj) => value is S)

      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: T, index: number, obj: T[]): value is S
        • +
            +
          • (value, index, obj): value is S
          • Parameters

            • -
              value: T
            • +
              value: T
            • -
              index: number
            • +
              index: number
            • -
              obj: T[]
            -

            Returns value is S

      • +
        obj: T[]
    +

    Returns value is S

  • -
    Optional thisArg: any
    +
    Optional thisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

  • -

    Returns undefined | S

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

        @@ -533,28 +535,28 @@ otherwise.

        Parameters

        • -
          predicate: ((value: T, index: number, obj: T[]) => unknown)
          +
          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: T, index: number, obj: T[]): unknown
            • +
                +
              • (value, index, obj): unknown
              • Parameters

                • -
                  value: T
                • +
                  value: T
                • -
                  index: number
                • +
                  index: number
                • -
                  obj: T[]
                +
                obj: T[]

        Returns unknown

  • -
    Optional thisArg: any
    +
    Optional thisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

  • @@ -562,88 +564,88 @@ predicate. If it is not provided, undefined is used instead.

    Inherited from Array.findIndex

    • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.core.d.ts:41
    -
    +
    -
      - +
        +
      • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

        -
        +

        Type Parameters

        -
          +
          • -

            A

          • +

            A

          • -

            D extends number = 1

        +

        D extends number = 1

    Parameters

    • -
      this: A
    • +
      this: A
    • -
      Optional depth: D
      +
      Optional depth: D

      The maximum recursion depth

    -

    Returns FlatArray<A, D>[]

    -
    +
    -
      - +
        +
      • Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

        -
        +

        Type Parameters

        -
          +
          • -

            U

          • +

            U

          • -

            This = undefined

        +

        This = undefined

    Parameters

    • -
      callback: ((this: This, value: T, index: number, array: T[]) => U | readonly U[])
      +
      callback: ((this, value, index, array) => U | readonly U[])

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

      • -
          -
        • (this: This, value: T, index: number, array: T[]): U | readonly U[]
        • +
            +
          • (this, value, index, array): U | readonly U[]
          • Parameters

            • -
              this: This
            • +
              this: This
            • -
              value: T
            • +
              value: T
            • -
              index: number
            • +
              index: number
            • -
              array: T[]
            -

            Returns U | readonly U[]

      • +
        array: T[]
    +

    Returns U | readonly U[]

  • -
    Optional thisArg: This
    +
    Optional thisArg: This

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

  • -

    Returns U[]

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

        @@ -651,44 +653,44 @@ thisArg is omitted, undefined is used as the this value.

        Parameters

        • -
          callbackfn: ((value: T, index: number, array: T[]) => void)
          +
          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: T, index: number, array: T[]): void
            • +
                +
              • (value, index, array): void
              • Parameters

                • -
                  value: T
                • +
                  value: T
                • -
                  index: number
                • +
                  index: number
                • -
                  array: T[]
                +
                array: T[]

              Returns void

        • -
          Optional thisArg: any
          +
          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

    -
    +
    -
    -
    +
  • Defined in src/circular-array.ts:84
  • +
    -
      - +
        +
      • Determines whether an array includes a certain element, returning true or false as appropriate.

        @@ -696,21 +698,21 @@ thisArg is omitted, undefined is used as the this value.

        Parameters

        • -
          searchElement: T
          +
          searchElement: T

          The element to search for.

        • -
          Optional fromIndex: number
          +
          Optional fromIndex: number

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

        Returns boolean

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

        @@ -718,21 +720,21 @@ thisArg is omitted, undefined is used as the this value.

        Parameters

        • -
          searchElement: T
          +
          searchElement: T

          The value to locate in the array.

        • -
          Optional fromIndex: number
          +
          Optional fromIndex: number

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

        Returns number

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

        @@ -740,28 +742,28 @@ thisArg is omitted, undefined is used as the this value.

        Parameters

        • -
          Optional separator: string
          +
          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

    -
    +
    -
      - +
        +
      • Returns an iterable of keys in the array

        -

        Returns IterableIterator<number>

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

        @@ -769,89 +771,91 @@ thisArg is omitted, undefined is used as the this value.

        Parameters

        • -
          searchElement: T
          +
          searchElement: T

          The value to locate in the array.

        • -
          Optional fromIndex: number
          +
          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

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

        -
        +

        Type Parameters

        -
          +
          • -

            U

        +

        U

    Parameters

    • -
      callbackfn: ((value: T, index: number, array: T[]) => U)
      +
      callbackfn: ((value, index, array) => U)

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

      • -
          -
        • (value: T, index: number, array: T[]): U
        • +
            +
          • (value, index, array): U
          • Parameters

            • -
              value: T
            • +
              value: T
            • -
              index: number
            • +
              index: number
            • -
              array: T[]
            -

            Returns U

      • +
        array: T[]
    +

    Returns U

  • -
    Optional thisArg: any
    +
    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[]

    -
    +
    -
      - +
        +
      • 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 | T

    -
    +
    -
      - +
        +
      • +
        +

        Inherit Doc

        Parameters

        • -
          Rest ...items: T[]
        +
        Rest ...items: T[]

      Returns number

    -
    +
  • Defined in src/circular-array.ts:21
  • +
    -
      - +
        +
      • 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.

        @@ -859,105 +863,105 @@ If the array is empty, undefined is returned and the array is not modified.

        Parameters

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

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

          • -
              -
            • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
            • +
                +
              • (previousValue, currentValue, currentIndex, array): T
              • Parameters

                • -
                  previousValue: T
                • +
                  previousValue: T
                • -
                  currentValue: T
                • +
                  currentValue: T
                • -
                  currentIndex: number
                • +
                  currentIndex: number
                • -
                  array: T[]
                -

                Returns T

          -

          Returns T

        +

        Returns T

    +

    Returns T

    - +
  • Parameters

    • -
      callbackfn: ((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)
      +
      callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
      • -
          -
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • +
            +
          • (previousValue, currentValue, currentIndex, array): T
          • Parameters

            • -
              previousValue: T
            • +
              previousValue: T
            • -
              currentValue: T
            • +
              currentValue: T
            • -
              currentIndex: number
            • +
              currentIndex: number
            • -
              array: T[]
            -

            Returns T

      • +
        array: T[]
    +

    Returns T

  • -
    initialValue: T
  • -

    Returns T

    Parameters

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

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

      • -
          -
        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • +
            +
          • (previousValue, currentValue, currentIndex, array): U
          • Parameters

            • -
              previousValue: U
            • +
              previousValue: U
            • -
              currentValue: T
            • +
              currentValue: T
            • -
              currentIndex: number
            • +
              currentIndex: number
            • -
              array: T[]
            -

            Returns U

      • +
        array: T[]
    +

    Returns U

  • -
    initialValue: U
    +
    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

    -
    +
    -
      - +
        +
      • 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.

        @@ -965,142 +969,142 @@ If the array is empty, undefined is returned and the array is not modified.

        Parameters

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

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

          • -
              -
            • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
            • +
                +
              • (previousValue, currentValue, currentIndex, array): T
              • Parameters

                • -
                  previousValue: T
                • +
                  previousValue: T
                • -
                  currentValue: T
                • +
                  currentValue: T
                • -
                  currentIndex: number
                • +
                  currentIndex: number
                • -
                  array: T[]
                -

                Returns T

          -

          Returns T

        +

        Returns T

    +

    Returns T

    - +
  • Parameters

    • -
      callbackfn: ((previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T)
      +
      callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
      • -
          -
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • +
            +
          • (previousValue, currentValue, currentIndex, array): T
          • Parameters

            • -
              previousValue: T
            • +
              previousValue: T
            • -
              currentValue: T
            • +
              currentValue: T
            • -
              currentIndex: number
            • +
              currentIndex: number
            • -
              array: T[]
            -

            Returns T

      • +
        array: T[]
    +

    Returns T

  • -
    initialValue: T
  • -

    Returns T

    Parameters

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

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

      • -
          -
        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • +
            +
          • (previousValue, currentValue, currentIndex, array): U
          • Parameters

            • -
              previousValue: U
            • +
              previousValue: U
            • -
              currentValue: T
            • +
              currentValue: T
            • -
              currentIndex: number
            • +
              currentIndex: number
            • -
              array: T[]
            -

            Returns U

      • +
        array: T[]
    +

    Returns U

  • -
    initialValue: U
    +
    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

    -
    +
    -
      - +
        +
      • Parameters

        • -
          size: number
        +
        size: number

      Returns void

    -
    +
  • Defined in src/circular-array.ts:68
  • +
    -
      - +
        +
      • Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

        -

        Returns 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 | T

    -
    +
    -
      - +
        +
      • 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. @@ -1110,23 +1114,23 @@ For example, -2 refers to the second to last element of the array.

        Parameters

        • -
          Optional start: number
          +
          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
          +
          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 T[]

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

        @@ -1134,28 +1138,28 @@ If end is undefined, then the slice extends to the end of the array.

        Parameters

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

          • -
              -
            • (value: T, index: number, array: T[]): unknown
            • +
                +
              • (value, index, array): unknown
              • Parameters

                • -
                  value: T
                • +
                  value: T
                • -
                  index: number
                • +
                  index: number
                • -
                  array: T[]
                +
                array: T[]

              Returns unknown

        • -
          Optional thisArg: any
          +
          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.

        @@ -1163,10 +1167,10 @@ If thisArg is omitted, undefined is used as the this value.

        Inherited from Array.some

        • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1430
    -
    +
    -
      - +
        +
      • Sorts an array in place. This method mutates the array and returns a reference to the same array.

        @@ -1175,52 +1179,54 @@ This method mutates the array and returns a reference to the same array.

        Parameters

        • -
          Optional compareFn: ((a: T, b: T) => number)
          +
          Optional compareFn: ((a, b) => 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)
          -
          +
          • -
              -
            • (a: T, b: T): number
            • +
                +
              • (a, b): number
              • Parameters

                • -
                  a: T
                • +
                  a: T
                • -
                  b: T
                +
                b: T

        Returns number

    -

    Returns CircularArray<T>

    -
    +
    -
      - +
        +
      • +
        +

        Inherit Doc

        Parameters

        • -
          start: number
        • +
          start: number
        • -
          Optional deleteCount: number
        • +
          Optional deleteCount: number
        • -
          Rest ...items: T[]
        -

        Returns T[]

      +

      Returns T[]

    -
    +
  • Defined in src/circular-array.ts:54
  • +
    -
      - +
        +
      • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

        @@ -1228,10 +1234,10 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact

        Inherited from Array.toLocaleString

        • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1313
    -
    +
    -
      - +
        +
      • Returns a string representation of an array.

        @@ -1239,194 +1245,196 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact

        Inherited from Array.toString

        • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1309
    -
    +
    -
      - +
        +
      • +
        +

        Inherit Doc

        Parameters

        • -
          Rest ...items: T[]
        +
        Rest ...items: T[]

      Returns number

    -
    +
  • Defined in src/circular-array.ts:30
  • +
    -
      - +
        +
      • Returns an iterable of values in the array

        -

        Returns IterableIterator<T>

    -
    +
    -
      - +
        +
      • Creates an array from an array-like object.

        -
        +

        Type Parameters

        -
          +
          • -

            T

        +

        T

    Parameters

    • -
      arrayLike: ArrayLike<T>
      +
      arrayLike: ArrayLike<T>

      An array-like object to convert to an array.

    -

    Returns T[]

    Parameters

    • -
      arrayLike: ArrayLike<T>
      +
      arrayLike: ArrayLike<T>

      An array-like object to convert to an array.

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

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

      • -
          -
        • (v: T, k: number): U
        • +
            +
          • (v, k): U
          • Parameters

            • -
              v: T
            • +
              v: T
            • -
              k: number
            -

            Returns U

      • +
        k: number
    +

    Returns U

  • -
    Optional thisArg: any
    +
    Optional thisArg: any

    Value of 'this' used to invoke the mapfn.

  • -

    Returns U[]

    Parameters

    • -
      iterable: Iterable<T> | ArrayLike<T>
      +
      iterable: Iterable<T> | ArrayLike<T>

      An iterable object to convert to an array.

    -

    Returns T[]

    Parameters

    • -
      iterable: Iterable<T> | ArrayLike<T>
      +
      iterable: Iterable<T> | ArrayLike<T>

      An iterable object to convert to an array.

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

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

      • -
          -
        • (v: T, k: number): U
        • +
            +
          • (v, k): U
          • Parameters

            • -
              v: T
            • +
              v: T
            • -
              k: number
            -

            Returns U

      • +
        k: number
    +

    Returns U

  • -
    Optional thisArg: any
    +
    Optional thisArg: any

    Value of 'this' used to invoke the mapfn.

  • -

    Returns U[]

    -
    +
    -
      - +
        +
      • Parameters

        • -
          arg: any
        -

        Returns arg is any[]

      +

      Returns arg is any[]

    -
    +
    -
      - +
        +
      • Returns a new array from a set of elements.

        -
        +

        Type Parameters

        -
          +
          • -

            T

        +

        T

    Parameters

    • -
      Rest ...items: T[]
      +
      Rest ...items: T[]

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

    -

    Returns T[]

    @@ -1444,97 +1452,101 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
  • -

    Theme

    +

    Theme

    On This Page

    +
  • constructor
  • +
  • [unscopables]
  • +
  • length
  • +
  • size
  • +
  • [species]
  • +
  • [iterator]
  • +
  • at
  • +
  • checkSize
  • +
  • concat
  • +
  • copyWithin
  • +
  • empty
  • +
  • entries
  • +
  • every
  • +
  • fill
  • +
  • filter
  • +
  • find
  • +
  • findIndex
  • +
  • flat
  • +
  • flatMap
  • +
  • forEach
  • +
  • full
  • +
  • includes
  • +
  • indexOf
  • +
  • join
  • +
  • keys
  • +
  • lastIndexOf
  • +
  • map
  • +
  • pop
  • +
  • push
  • +
  • reduce
  • +
  • reduceRight
  • +
  • resize
  • +
  • reverse
  • +
  • shift
  • +
  • slice
  • +
  • some
  • +
  • sort
  • +
  • splice
  • +
  • toLocaleString
  • +
  • toString
  • +
  • unshift
  • +
  • values
  • +
  • from
  • +
  • isArray
  • +
  • of
  • +
  • PoolType
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • MessageValue
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • RequiredStatistics
  • +
  • Task
  • +
  • TasksQueueOptions
  • +
  • TasksUsage
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • Draft
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • ThreadWorkerWithMessageChannel
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • KillBehaviors
  • +
  • PoolEvents
  • +
  • WorkerChoiceStrategies
  • Generated using TypeDoc

    \ No newline at end of file