X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=4bfbe0e79047b682385c9c05adc4183567c5be98;hb=493f77bdef6d66ad2fcb72b405c805274b24f3db;hp=0297f8fcce90d0308a78c06d3b0c07eb62564526;hpb=3bd6a82e43e11294af91bbd19647944ac740169e;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 0297f8fc..4bfbe0e7 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -18,9 +18,9 @@

Array with a maximum length and shifting items when full.

-
+

Type Parameters

-
@@ -30,7 +30,7 @@
+
  • Defined in src/circular-array.ts:8
  • @@ -95,11 +95,11 @@
      - +
    • -
      +

      Type Parameters

      -
        +
        • T

      @@ -109,15 +109,15 @@
      size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
    • Rest ...items: T[]
    -

    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,12 +125,12 @@ when they will be absent when used in a 'with' statement.

    Type declaration

    -
    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
    @@ -160,7 +160,7 @@ when they will be absent when used in a 'with' statement.

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

    Returns CircularArray<T>

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

    Returns value is S

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

    +

    Returns value is S

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

    @@ -413,7 +415,7 @@ length+end.

    Inherited from Array.filter

    • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1448
  • - +
  • Returns the elements of an array that meet the condition specified in a callback function.

    @@ -450,21 +452,21 @@ length+end.

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

      -
      +

      Type Parameters

      -
        +
        • S

      Parameters

      • -
        predicate: ((value, index, obj) => 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.

        @@ -472,7 +474,7 @@ immediately returns that element value. Otherwise, find returns undefined.

          • -
          • (value, index, obj): value is S
          • +
          • (value, index, obj): value is S
          • Parameters

            @@ -483,7 +485,7 @@ immediately returns that element value. Otherwise, find returns undefined.

            index: number
          • obj: T[]
        -

        Returns value is S

  • +

    Returns value is S

  • Optional thisArg: any

    If provided, it will be used as the this value for each invocation of @@ -493,7 +495,7 @@ predicate. If it is not provided, undefined is used instead.

    Inherited from Array.find

    • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2015.core.d.ts:29
  • - +
  • Parameters

    @@ -524,7 +526,7 @@ predicate. If it is not provided, undefined is used instead.

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

      @@ -565,14 +567,14 @@ predicate. If it is not provided, undefined is used instead.

        - +
      • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

        -
        +

        Type Parameters

        -
          +
          • A

          • @@ -593,15 +595,15 @@ specified depth.

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

                • @@ -643,7 +645,7 @@ thisArg is omitted, undefined is used as the this value.

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

                    @@ -680,15 +682,15 @@ thisArg is omitted, undefined is used as the this value.

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

                @@ -710,7 +712,7 @@ thisArg is omitted, undefined is used as the this value.

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

                  @@ -732,7 +734,7 @@ thisArg is omitted, undefined is used as the this value.

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

                    @@ -750,7 +752,7 @@ thisArg is omitted, undefined is used as the this value.

                      - +
                    • Returns an iterable of keys in the array

                      @@ -761,7 +763,7 @@ thisArg is omitted, undefined is used as the this value.

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

                        @@ -783,13 +785,13 @@ thisArg is omitted, undefined is used as the this value.

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

                          -
                          +

                          Type Parameters

                          -
                            +
                            • U

                          @@ -825,7 +827,7 @@ thisArg is omitted, undefined is used as the this value.

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

                            @@ -837,8 +839,10 @@ If the array is empty, undefined is returned and the array is not modified.

                              - +
                            • +
                              +

                              Inherit Doc

                              Parameters

                                @@ -847,11 +851,11 @@ If the array is empty, undefined is returned and the array is not modified.

                                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.

                          @@ -883,7 +887,7 @@ If the array is empty, undefined is returned and the array is not modified.

                          Inherited from Array.reduce

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

                          @@ -913,13 +917,13 @@ If the array is empty, undefined is returned and the array is not modified.

                          Inherited from Array.reduce

                          • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1461
                        • - +
                        • 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

                          @@ -957,7 +961,7 @@ If the array is empty, undefined is returned and the array is not modified.

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

                            @@ -989,7 +993,7 @@ If the array is empty, undefined is returned and the array is not modified.

                            Inherited from Array.reduceRight

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

                            @@ -1019,13 +1023,13 @@ If the array is empty, undefined is returned and the array is not modified.

                            Inherited from Array.reduceRight

                            • Defined in node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1474
                          • - +
                          • 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

                            @@ -1063,7 +1067,7 @@ If the array is empty, undefined is returned and the array is not modified.

                              - +
                            • Parameters

                              @@ -1072,11 +1076,11 @@ If the array is empty, undefined is returned and the array is not modified.

                              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.

                        @@ -1088,7 +1092,7 @@ This method mutates the array and returns a reference to the same array.

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

                          @@ -1100,7 +1104,7 @@ If the array is empty, undefined is returned and the array is not modified.

                            - +
                          • 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. @@ -1126,7 +1130,7 @@ If end is undefined, then the slice extends to the end of the array.

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

                              @@ -1166,7 +1170,7 @@ If thisArg is omitted, undefined is used as the this value.

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

                                @@ -1180,7 +1184,7 @@ This method mutates the array and returns a reference to the same array.

                                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)
                                -
                                +
                                • @@ -1195,15 +1199,17 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
                                • b: T

                            Returns number

      -

      Returns CircularArray<T>

      - +
    • +
      +

      Inherit Doc

      Parameters

        @@ -1216,11 +1222,11 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact

        Returns T[]

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