X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=6db6b3cc1e6b5e66374aea921f8c98f7926daea8;hb=b537ee9c5e0688123d228f7b0d80bcba516f55a3;hp=1bfdddd3f17110e401532669a5230925a0fb28a1;hpb=601deb7292c99dfe7b6ad43935759933f32adca1;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 1bfdddd3..6db6b3cc 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,1628 +1,184 @@ -CircularArray | poolifier - v3.0.3
-
- -
-
-
-
- -

Class CircularArray<T>Internal

-
-

Array with a maximum length and shifting items when full.

-
-
-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
    -
  • Array<T> -
      -
    • CircularArray
-
-
-
- -
-
-

Constructors

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

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

    Returns CircularArray<T>

-
-

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' +CircularArray | poolifier - v4.0.10

Class CircularArray<T>Internal

Array with a maximum length and shifting items when full.

+

Type Parameters

  • T

    Type of items.

    +

Hierarchy

  • Array<T>
    • CircularArray

Constructors

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.

-
-
-

Type declaration

-
    -
  • -
    Optional Readonly [unscopables]?: boolean
    -

    Is an object whose properties have the value 'true' +

    Type declaration

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

      -
      -
    -
-
- -
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
-
- -
[species]: ArrayConstructor
-
-

Methods

-
- -
    - -
  • -

    Iterator

    -
    -

    Returns IterableIterator<T>

    -
-
- -
    - -
  • -

    Returns the item located at the specified index.

    -
    -
    -

    Parameters

    -
      -
    • -
      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 the this object after copying a section of the array identified by start and end +

  • 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

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

+
size: number
[species]: ArrayConstructor

Methods

  • Iterator

    +

    Returns IterableIterator<T>

  • Returns the item located at the specified index.

    +

    Parameters

    • 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 the this object after copying a section of the array identified by start and end to the same array starting at position target

    -
    -
    -

    Parameters

    -
      -
    • -
      target: number
      -

      If target is negative, it is treated as length+target where length is the +

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

        -
        -
      • -
      • -
        start: number
        -

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

      • start: number

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

        -
        -
      • -
      • -
        Optional end: number
        -

        If not specified, length of the this object is used as its default value.

        -
        -
      -

      Returns CircularArray<T>

      -
-
- -
-
- -
    - -
  • -

    Returns an iterable of key, value pairs for every entry in the array

    -
    -

    Returns IterableIterator<[number, T]>

    -
-
- -
    - -
  • -

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

    -
    -
    -

    Type Parameters

    -
      -
    • -

      S

    -
    -

    Parameters

    -
      -
    • -
      predicate: ((value, index, array) => value is S)
      -

      A function that accepts up to three arguments. The every method calls +

    • Optional end: number

      If not specified, length of the this object is used as its default value.

      +

    Returns this

  • Returns an iterable of key, value pairs for every entry in the array

    +

    Returns IterableIterator<[number, T]>

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

    +

    Type Parameters

    • S

    Parameters

    • 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, index, array): value is S
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

          Returns value is S

    • -
    • -
      Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. +

        • (value, index, array): value is S
        • Parameters

          • value: T
          • index: number
          • array: T[]

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

    -
  • - -
  • -

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

    -
    -
    -

    Parameters

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

      A function that accepts up to three arguments. The every method calls +

    Returns this is S[]

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

    +

    Parameters

    • 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, index, array): unknown
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

          Returns unknown

    • -
    • -
      Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. +

        • (value, index, array): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • 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

    -
-
- -
    - -
  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -
    -
    -

    Parameters

    -
      -
    • -
      value: T
      -

      value to fill array section with

      -
      -
    • -
    • -
      Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as +

    Returns boolean

  • Changes all array elements from start to end index to a static value and returns the modified array

    +

    Parameters

    • value: T

      value to fill array section with

      +
    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      -
      -
    • -
    • -
      Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as +

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

      -
      -
    -

    Returns CircularArray<T>

    -
-
- -
    - -
  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      S

    -
    -

    Parameters

    -
      -
    • -
      predicate: ((value, index, array) => value is S)
      -

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

      -
      -
      -
        -
      • -
          -
        • (value, index, array): value is S
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

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

    -
  • - -
  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -
    -
    -

    Parameters

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

      -
      -
      -
        -
      • -
          -
        • (value, index, array): unknown
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

          Returns unknown

    • -
    • -
      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 the value of the first element in the array where predicate is true, and undefined +

Returns this

-
- -

Returns undefined | S

  • Parameters

    Returns undefined | T

  • -
    - -

    Returns number

    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -

    Returns U[]

    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -

    Returns boolean

    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns this

    \ No newline at end of file