Internal Determines whether all the members of an array satisfy the specified test.
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.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Determines whether all the members of an array satisfy the specified test.
+Determines whether all the members of an array satisfy the specified test.
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.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Changes all array elements from start to end index to a static value and returns the modified array
value to fill array section with
Optional start: numberindex 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: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
-Returns the elements of an array that meet the condition specified in a callback function.
+Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Returns the elements of an array that meet the condition specified in a callback function.
+Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Returns the value of the first element in the array where predicate is true, and undefined +
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Optional thisArg: anyReturns the index of the first element in the array where predicate is true, and -1 +
Optional thisArg: anyReturns the index of the first element in the array where predicate is true, and -1 otherwise.
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Returns a new array with all sub-array elements concatenated into it recursively up to the +
Calls a defined callback function on each element of an array. Then, flattens the result into +
Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.
A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg: ThisAn object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.
-Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
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.
-Determines whether an array includes a certain element, returning true or false as appropriate.
+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.
+Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
The value to locate in the array.
Optional fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
-Adds all the elements of an array into a string, separated by the specified separator string.
+Adds all the elements of an array into a string, separated by the specified separator string.
Optional separator: stringA string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
-Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
+Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
The value to locate in the array.
Optional fromIndex: numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
-Calls a defined callback function on each element of an array, and returns an array that contains the results.
+Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
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.
-Removes the last element from an array and returns it. +
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.
+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.
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.
-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.
+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.
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.
+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. +
Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
Optional start: numberThe beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
Optional end: numberThe end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.
-Determines whether the specified callback function returns true for any element of an array.
+Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Sorts an array in place. This method mutates the array and returns a reference to the same array.
Optional compareFn: ((a, b) => number)Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive 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[]Rest ...items: T[]Static fromOptional deleteCount: numberRest ...items: T[]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.
+Creates an array from an iterable object.
Creates an array from an iterable object.
+Creates an array from an iterable object.
Creates an array from an iterable object.
+Creates an array from an iterable object.
Static isStatic ofStatic 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.27Class CircularArray<T>
InternalArray with a maximum length and shifting items when full.
Type Parameters
Type of items.
-Hierarchy
Index
Constructors
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Type Parameters
Parameters
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
Parameters
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
-Returns IterableIterator<T>
at
Returns the item located at the specified index.
+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
+Returns IterableIterator<T>
at
Returns the item located at the specified index.
Parameters
The zero-based index of the desired code unit. A negative index will count back from the last item.
-Returns undefined | T
PrivatecheckParameters
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
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
If target is negative, it is treated as length+target where length is the length of the array.
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 IterableIterator<[number, T]>
every
Determines whether all the members of an array satisfy the specified test.
+Returns this