X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=3c0753f8653273f8f7e12ecda068ab15828b2e05;hb=cc35cd9cb7323e39c9f521cdd4fbf51d1d31bbdf;hp=3092146dabce2f23c275fcc06896ec3330173bff;hpb=85003dff831b309b12d624215a8d67634af82b50;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 3092146d..3c0753f8 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,4 +1,4 @@ -CircularArray | poolifier - v2.6.14
+CircularArray | poolifier - v2.6.40
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.14
+
  • The search index is not available
  • poolifier - v2.6.40
    @@ -14,7 +14,7 @@ -

    Class CircularArray<T>

    +

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    @@ -31,7 +31,7 @@
    +
  • Defined in src/circular-array.ts:10
  • @@ -109,11 +109,11 @@
  • size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
  • -
    Rest ...items: T[]
  • +
    Rest ...items: T[]
    Rest

    Returns CircularArray<T>

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

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

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
  • length: number
    @@ -148,18 +148,18 @@ when they will be absent when used in a 'with' statement.

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1318
  • size: number
    +
  • Defined in src/circular-array.ts:11
  • [species]: ArrayConstructor
    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
  • Methods

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

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:58
  • +

    Returns undefined | T

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2022.array.d.ts:24
  • Returns void

    +
  • Defined in src/circular-array.ts:100
  • Returns CircularArray<T>

    Inherit Doc

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

    Returns CircularArray<T>

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:62
  • +
  • Defined in src/circular-array.ts:92
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:63
  • Determines whether all the members of an array satisfy the specified test.

    @@ -337,7 +331,6 @@ If thisArg is omitted, undefined is used as the this value.

    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.

    -
      • @@ -357,13 +350,12 @@ 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.

        -
        -
      +Optional

    Returns boolean

  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1434
  • +Optional

    Returns CircularArray<T>

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:51
  • Returns the elements of an array that meet the condition specified in a callback function.

    @@ -452,7 +439,6 @@ length+end.

    predicate: ((value, index, array) => unknown)

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

    -
      • @@ -471,13 +457,12 @@ length+end.

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

        -
        -
    +Optional
  • Returns T[]

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1467
  • @@ -550,11 +533,11 @@ predicate. If it is not provided, undefined is used instead.

    obj: T[]
  • Returns unknown

  • -
    Optional thisArg: any
  • +
    Optional thisArg: any
    Optional

    Returns undefined | T

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:30
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:41
  • +Optional

    Returns FlatArray<A, D>[]

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2019.array.d.ts:79
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2019.array.d.ts:68
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1449
  • +
  • Defined in src/circular-array.ts:96
  • +Optional

    Returns boolean

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25
  • +Optional

    Returns number

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1410
  • +Optional

    Returns string

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1353
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:68
  • +Optional

    Returns number

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1416
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1455
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1331
  • Returns number

    Inherit Doc

    +
  • Defined in src/circular-array.ts:23
  • Returns U

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1480
  • Returns U

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1493
  • Returns void

    +
  • Defined in src/circular-array.ts:80
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1358
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1363
  • +Optional

    Returns T[]

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1373
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1443
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1384
  • -

    Returns T[]

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

    Returns CircularArray<T>

    Inherit Doc

    +
  • Defined in src/circular-array.ts:56
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1326
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1322
  • Returns number

    Inherit Doc

    +
  • Defined in src/circular-array.ts:32
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:73
  • +

    Returns T[]

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:70
  • Creates an array from an iterable object.

    @@ -1396,13 +1351,11 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
  • arrayLike: ArrayLike<T>

    An array-like object to convert to an array.

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

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

    -
      • @@ -1419,13 +1372,12 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -
        -
      +Optional

    Returns U[]

  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:78
  • Creates an array from an iterable object.

    @@ -1441,13 +1393,12 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
  • iterable: Iterable<T> | ArrayLike<T>

    An iterable object to convert to an array.

    -
    -
  • +

    Returns T[]

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:81
  • Creates an array from an iterable object.

    @@ -1465,13 +1416,11 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
  • iterable: Iterable<T> | ArrayLike<T>

    An iterable object to convert to an array.

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

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

    -
      • @@ -1488,13 +1437,12 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -
        -
      +Optional

    Returns U[]

  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:89
  • +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1505
  • +Rest

    Returns T[]

    +
  • Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:84
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file