X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=c57b1f607798b68dd56818161a6c883b50e6c172;hb=a6b5c73ccccb3ef0ccc24ad462182e3cacee77b4;hp=5aefab3dd2e9979fb23949bb50bf78fba8c6a58d;hpb=d655c2c2b159a39f900230c14b301ba123653362;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 5aefab3d..c57b1f60 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,4 +1,4 @@ -CircularArray | poolifier
+CircularArray | poolifier - v2.6.9
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.9
    @@ -17,20 +17,21 @@

    Class CircularArray<T>

    Array with a maximum length and shifting items when full.

    -
    -
    +
    +
    +

    Type Parameters

    -
    +

    T

    Hierarchy

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

    Constructors

    -
    - -
      - +
      + +
        +
      • -
        +

        Type Parameters

        -
          +
          • -

            T

        +

        T

      Parameters

      • -
        size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
      • +
        size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
      • -
        Rest ...items: T[]
      -

      Returns CircularArray<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,53 +126,58 @@ 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
    +
  • 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.

    -
    -
    - -
    size: number
    +
    + +
    size: number
    -
    - -
    [species]: ArrayConstructor
    +
    + +
    [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 the item located at the specified index.

      @@ -179,44 +185,48 @@ 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

    +

    Returns undefined | T

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

      • -
        size: number
      +
      size: number

    Returns void

    -
    - -
    +
    + +
      +
    • Parameters

      • -
        Rest ...items: (T | ConcatArray<T>)[]
      -

      Returns CircularArray<T>

    +

    Returns CircularArray<T>

    +
    +

    Inherit Doc

    -
    - -
    +
    + +
      +
    • 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 +235,96 @@ 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
      +
      Optional start: number

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

      -
    • +is treated as length+end. If start is omitted, 0 is used.

      + +
    • -
      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 node_modules/.pnpm/typescript@5.1.6/node_modules/typescript/lib/lib.es2015.core.d.ts:62
    +
    + +
    -
    - -
    +
    + +
      +
    • Returns an iterable of key, value pairs for every entry in the array

      -

      Returns IterableIterator<[number, T]>

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

      -
      +

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

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

    @@ -314,39 +332,42 @@ If thisArg is omitted, undefined is used as the this value.

    Parameters

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

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

      -
    -

    Returns boolean

  • +

    Returns boolean

    +
    -
    - -
    +
    + + +

    Returns CircularArray<T>

    +
    -
    - -
    +
    + +

    Parameters

    +

    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 elements of an array that meet the condition specified in a callback function.

    @@ -421,110 +449,116 @@ length+end.

    Parameters

    -

    Returns T[]

  • +

    Returns T[]

    +
    -
    - -
    +
    + +

    Parameters

    +

    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

    +
  • Parameters

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

    Returns undefined | T

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

    -
    - -
    +
    + +

    Parameters

    -

    Returns FlatArray<A, D>[]

    +
    + +

    Parameters

    +

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

    +
    + + +

    Returns void

    +
    -
    - -
    +
    + +
    -
    - -
    +
    + + +

    Returns boolean

    +
    -
    - -
    +
    + + +

    Returns number

    +
    -
    - -
    +
    + + +

    Returns string

    +
    -
    - -
    +
    + +
    -
    - -
    +
    + + +

    Returns number

    +
    -
    - -
    +
    + +

    Parameters

    +

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

    +
    + +
    -
    - -
    +
    + + +

    Returns number

    +
    +

    Inherit Doc

    -
    - -
    +
    + + +

    Returns T

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

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

    +

    U

  • Parameters

    +

    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

    +
    + + +

    Returns T

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

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

    +

    U

  • Parameters

    +

    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

    +
    + +

    Returns void

    -
    - -
    +
    + +
    -
    - -
    +
    + +
    -
    - -
    +
    + + -

    Returns T[]

    -
    - -
    +
    + + +

    Returns boolean

    +
    -
    - -
    +
    + + -

    Returns CircularArray<T>

    -
    - -
    +
    + + +

    Returns T[]

    +
    +

    Inherit Doc

    -
    - -
    +
    + +
    -
    - -
    +
    + +
    -
    - -
    +
    + + +

    Returns number

    +
    +

    Inherit Doc

    -
    - -
    +
    + +
    -
    - -
    +
    + +

    Parameters

    -

    Returns T[]

    +
  • Creates an array from an iterable object.

    -
    +

    Type Parameters

    -
      +
      • -

        T

      • +

        T

      • -

        U

    +

    U

  • Parameters

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

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

    +
    +

    Returns U

  • -
    Optional thisArg: any
    +
    Optional thisArg: any

    Value of 'this' used to invoke the mapfn.

    -
  • -

    Returns U[]

    +
  • Creates an array from an iterable object.

    -
    +

    Type Parameters

    -
      +
      • -

        T

    +

    T

  • Parameters

    -

    Returns T[]

    +
  • Creates an array from an iterable object.

    -
    +

    Type Parameters

    -
      +
      • -

        T

      • +

        T

      • -

        U

    +

    U

  • Parameters

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

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

    +
    +

    Returns U

  • -
    Optional thisArg: any
    +
    Optional thisArg: any

    Value of 'this' used to invoke the mapfn.

    -
  • -

    Returns U[]

    +
    + + +

    Returns arg is any[]

    -
    - -
    +
    + +

    Parameters

    -

    Returns T[]

    -

    On This Page

    +

    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
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • EventLoopUtilizationMeasurementStatistics
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • IWorkerNode
  • +
  • MeasurementOptions
  • +
  • MeasurementStatistics
  • +
  • MeasurementStatisticsRequirements
  • +
  • MessageValue
  • +
  • PoolInfo
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • StrategyPolicy
  • +
  • Task
  • +
  • TaskError
  • +
  • TaskPerformance
  • +
  • TaskStatistics
  • +
  • TaskStatisticsRequirements
  • +
  • TasksQueueOptions
  • +
  • ThreadPoolOptions
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerInfo
  • +
  • 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