X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=5cb33feace2e4f69eceb523706d16eb1b3cd67d0;hb=b667be1103b9362ae29d094de05f812468464d4f;hp=4bfbe0e79047b682385c9c05adc4183567c5be98;hpb=493f77bdef6d66ad2fcb72b405c805274b24f3db;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 4bfbe0e7..5cb33fea 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,4 +1,4 @@ -CircularArray | poolifier
+CircularArray | poolifier - v2.6.8
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.8
    @@ -17,7 +17,8 @@

    Class CircularArray<T>

    Array with a maximum length and shifting items when full.

    -
    +
    +

    Type Parameters

    +
  • Defined in src/circular-array.ts:8
  • @@ -38,64 +39,64 @@

    Constructors

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

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

    @@ -128,50 +129,55 @@ when they will be absent when used in a 'with' statement.

    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

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

    -
  • +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
  • - +
    length: number

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

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

    - +
      - +
    • Iterator

      -

      Returns IterableIterator<T>

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

    Returns undefined | T

    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es2022.array.d.ts:24
  • - +

    Returns void

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

    Returns CircularArray<T>

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

    @@ -321,6 +337,7 @@ 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.

    +
      • @@ -340,15 +357,17 @@ 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

    +

    Returns boolean

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

    Returns CircularArray<T>

    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/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.

    @@ -426,6 +452,7 @@ 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.

    +
      • @@ -444,15 +471,17 @@ 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.

        -
      -

      Returns T[]

    +

    Returns T[]

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

    @@ -522,11 +554,11 @@ predicate. If it is not provided, undefined is used instead.

    Returns undefined | T

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

    Returns FlatArray<A, D>[]

    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es2019.array.d.ts:79
  • - + +

    Returns U[]

    +
    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es2019.array.d.ts:68
  • - +
    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es5.d.ts:1449
  • - +
    +
  • Defined in src/circular-array.ts:84
  • - + -

    Returns boolean

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

    Returns number

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

    Returns string

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

    Returns number

    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es5.d.ts:1416
  • - +
    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es5.d.ts:1455
  • - +
    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es5.d.ts:1331
  • - +
    +
  • Defined in src/circular-array.ts:21
  • - + -

    Returns T

    +
  • Parameters

    @@ -916,8 +977,8 @@ If the array is empty, undefined is returned and the array is not modified.

    Returns T

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

    @@ -933,6 +994,7 @@ If the array is empty, undefined is returned and the array is not modified.

    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.

    +
      • @@ -953,15 +1015,17 @@ If the array is empty, undefined is returned and the array is not modified.

      • 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

    +

    Returns U

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

    Returns T

    +
  • Parameters

    @@ -1022,8 +1088,8 @@ If the array is empty, undefined is returned and the array is not modified.

    Returns T

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

    @@ -1039,6 +1105,7 @@ If the array is empty, undefined is returned and the array is not modified.

    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.

    +
      • @@ -1059,15 +1126,17 @@ If the array is empty, undefined is returned and the array is not modified.

      • 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

    +

    Returns U

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

    Returns void

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

    Returns T[]

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

    Returns CircularArray<T>

    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es5.d.ts:1384
  • - +
    +
  • Defined in src/circular-array.ts:54
  • - +
    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es5.d.ts:1326
  • - +
    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es5.d.ts:1322
  • - +
    +
  • Defined in src/circular-array.ts:30
  • - +
    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es2015.iterable.d.ts:73
  • - + -

    Returns T[]

    +
  • Creates an array from an iterable object.

    @@ -1312,11 +1396,13 @@ 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.

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

        Value of 'this' used to invoke the mapfn.

        -
      -

      Returns U[]

    +

    Returns U[]

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

    @@ -1353,12 +1441,14 @@ 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[]

    +
  • Creates an array from an iterable object.

    @@ -1375,11 +1465,13 @@ 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.

    +
      • @@ -1396,15 +1488,17 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -
      -

      Returns U[]

    +

    Returns U[]

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

    Returns T[]

    +
  • Defined in node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es2015.core.d.ts:84
  • +
  • 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
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • EventLoopUtilizationMeasurementStatistics
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • MeasurementOptions
  • +
  • MeasurementStatistics
  • +
  • MeasurementStatisticsRequirements
  • +
  • MessageValue
  • +
  • PoolInfo
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • StrategyPolicy
  • +
  • Task
  • +
  • TaskError
  • +
  • TaskPerformance
  • +
  • TaskStatistics
  • +
  • TaskStatisticsRequirements
  • +
  • TasksQueueOptions
  • +
  • ThreadPoolOptions
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerInfo
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • WorkerStatistics
  • +
  • WorkerUsage
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • Measurement
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • PoolType
  • +
  • TaskFunctions
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • WorkerType
  • +
  • KillBehaviors
  • +
  • Measurements
  • +
  • PoolEvents
  • +
  • PoolTypes
  • +
  • WorkerChoiceStrategies
  • +
  • WorkerTypes
  • +
  • availableParallelism
  • Generated using TypeDoc

    \ No newline at end of file