Internal Determines whether an array includes a certain element, returning true or false as appropriate.
The element to search for.
Optional fromIndex: numberThe position in this array at which to begin searching for searchElement.
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
@@ -130,7 +130,7 @@ thisArg is omitted, undefined is used as the this value.Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Rest ...items: T[]Rest ...items: 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.
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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
@@ -140,7 +140,7 @@ If the array is empty, undefined is returned and the array is not modified.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.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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.
-Reverses the elements in an array in place. +
Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
@@ -164,9 +164,9 @@ a negative value if the first argument is less than the second argument, zero if value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.[11,2,22,1].sort((a, b) => a - b)
Optional deleteCount: numberRest ...items: T[]Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
+Optional deleteCount: numberRest ...items: T[]Rest ...items: T[]Returns an iterable of values in the array
+Rest ...items: T[]Static fromCreates an array from an array-like object.
An array-like object to convert to an array.
Creates an array from an iterable object.
@@ -181,4 +181,4 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charactOptional thisArg: anyValue of 'this' used to invoke the mapfn.
Static isStatic ofGenerated using TypeDoc
Generated using TypeDoc
Array with a maximum length and shifting items when full.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.20Class CircularArray<T>
InternalArray with a maximum length and shifting items when full.
Type Parameters
T
Type of items.
-Hierarchy
Index
Constructors
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Type Parameters
T
Parameters
size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
Rest...items: T[]Returns CircularArray<T>
Properties
Readonly[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' +
Constructors
constructor
Type Parameters
T
Parameters
size: number = DEFAULT_CIRCULAR_ARRAY_SIZE
Rest...items: T[]Returns CircularArray<T>
Properties
Readonly[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
OptionalReadonly[unscopables]?: booleanIs an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Optionallength?: booleanGets or sets the length of the array. This is a number one higher than the highest index in the array.
length
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
-size
StaticReadonly[species]Methods
[iterator]
Iterator
+size
StaticReadonly[species]Methods
[iterator]
Iterator
Returns IterableIterator<T>
at
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
PrivatecheckParameters
size: number
Returns void
concat
Parameters
Rest...items: (T | ConcatArray<T>)[]Returns CircularArray<T>
Inherit Doc
copy
Returns the this object after copying a section of the array identified by start and end +
Returns undefined | T
PrivatecheckParameters
size: number
Returns void
concat
Parameters
Rest...items: (T | ConcatArray<T>)[]Returns CircularArray<T>
Inherit Doc
copy
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 length of the array.
start: number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optionalend: numberIf not specified, length of the this object is used as its default value.
-Returns this
empty
Returns boolean
entries
Returns an iterable of key, value pairs for every entry in the array
+Returns this
empty
Returns boolean
entries
Returns an iterable of key, value pairs for every entry in the array
Returns IterableIterator<[number, T]>
every
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 @@ -113,7 +113,7 @@ thisArg is omitted, undefined is used as the this value.
Returns U[]
for
Performs the specified action for each element in an array.
Parameters
callbackfn: ((value, index, array) => void)
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Parameters
value: T
index: number
array: T[]
Returns void
OptionalthisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Returns void
full
Returns boolean
includes
Determines whether an array includes a certain element, returning true or false as appropriate.
+Returns void