X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=4bfbe0e79047b682385c9c05adc4183567c5be98;hb=66fc6ae43f2e7a308cdba9d5038d07cf49b9cda4;hp=c910db3b8e3c1a7703a88c64a7f48350201d85a2;hpb=6047493a00c2852f2c7f4329def8e1322c678cf1;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index c910db3b..4bfc89b3 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,123 +1,124 @@ -CircularArray | poolifier
+CircularArray | poolifier - v2.7.5
-
+
  • The search index is not available
  • poolifier - v2.7.5 +
    -

    Class CircularArray<T>

    +

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    -
    -
    +
    +
    +

    Type Parameters

    -
    +

    T

    Hierarchy

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

    Constructors

    -
    - - +

    Returns CircularArray<T>

    +
  • Defined in src/circular-array.ts:13
  • 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.2.2/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.2.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
  • Methods

    -
    - -
    +
    + + +

    Returns undefined | T

    +
    -
    - -
    +
    + +

    Returns void

    -
    - -
    +
    + + +

    Returns CircularArray<T>

    +
    +

    Inherit Doc

    -
    - -
    +
    + + -

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

    -

    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

    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.2.2/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.2.2/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 CircularArray<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[]

    +

    Theme

    -

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

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file