X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularArray.html;h=4bfbe0e79047b682385c9c05adc4183567c5be98;hb=493f77bdef6d66ad2fcb72b405c805274b24f3db;hp=0297f8fcce90d0308a78c06d3b0c07eb62564526;hpb=3bd6a82e43e11294af91bbd19647944ac740169e;p=poolifier.git
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 0297f8fc..4bfbe0e7 100644
--- a/docs/classes/CircularArray.html
+++ b/docs/classes/CircularArray.html
@@ -18,9 +18,9 @@
Is an object whose properties have the value 'true'
when they will be absent when used in a 'with' statement.Type Parameters
-
+
T
@@ -95,11 +95,11 @@
constructor
-
Type Parameters
-
+
T
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;
}
    [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;
}
Optional
Readonly
[unscopables]?: booleanOptional
Readonly
[unscopables]?: booleanIs an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Optional
length?: booleanOptional
length?: booleanGets or sets the length of the array. This is a number one higher than the highest index in the array.
Inherited from Array.[unscopables]
@@ -138,7 +138,7 @@ when they will be absent when used in a 'with' statement.Gets or sets the length of the array. This is a number one higher than the highest index in the array.
Inherited from Array.length
@@ -146,12 +146,12 @@ when they will be absent when used in a 'with' statement.Static
Readonly
[species]Inherited from Array.[species]
Iterator
Returns the item located at the specified index.
Private
checkRest
...items: (T | ConcatArray<T>)[]Overrides Array.concat
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
@@ -238,22 +240,22 @@ is treated as length+end.Optional
end: numberIf not specified, length of the this object is used as its default value.
Inherited from Array.copyWithin
Returns an iterable of key, value pairs for every entry in the array
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.
@@ -285,7 +287,7 @@ 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.
Inherited from Array.every
Determines whether all the members of an array satisfy the specified test.
Changes all array elements from start
to end
index to a static value
and returns the modified array
index to stop filling the array at. If end is negative, it is treated as length+end.
Inherited from Array.fill
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.
@@ -413,7 +415,7 @@ length+end.Inherited from Array.filter
Returns the elements of an array that meet the condition specified in a callback function.
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.
@@ -472,7 +474,7 @@ 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 @@ -493,7 +495,7 @@ predicate. If it is not provided, undefined is used instead.
Inherited from Array.find
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
@@ -565,14 +567,14 @@ 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 specified depth.
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.
Performs the specified action for each element in an array.
Determines whether an array includes a certain element, returning true or false as appropriate.
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
Adds all the elements of an array into a string, separated by the specified separator string.
Returns an iterable of keys in the array
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
@@ -837,8 +839,10 @@ If the array is empty, undefined is returned and the array is not modified.Overrides Array.push
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.
Inherited from Array.reduce
Inherited from Array.reduce
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, 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.
Inherited from Array.reduceRight
Inherited from Array.reduceRight
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.
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
@@ -1088,7 +1092,7 @@ This method mutates the array and returns a reference to the same array.Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
@@ -1100,7 +1104,7 @@ If the array is empty, undefined is returned and the array is not modified.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. @@ -1126,7 +1130,7 @@ 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.
Sorts an array in place. This method mutates the array and returns a reference to the same array.
@@ -1180,7 +1184,7 @@ This method mutates the array and returns a reference to the same array. 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)
-
+
Inherited from Array.sort
Overrides Array.splice
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
Returns a string representation of an array.
Overrides Array.unshift
Returns an iterable of values in the array
Static
fromCreates an array from an array-like object.
Inherited from Array.from
Creates an array from an iterable object.
Inherited from Array.from
Creates an array from an iterable object.
Inherited from Array.from
Creates an array from an iterable object.
Static
isStatic
ofReturns a new array from a set of elements.
Array with a maximum length and shifting items when full.