X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FCircularArray.html;h=3a3a38bf07fe2ac5e3c045cbcdd0bfde8808e8ca;hb=c4424e52e4924efa5eef704cb5dcb82f2760e0da;hp=438b9b5b637f4095a1cdb1e03e8e652b774e9347;hpb=1bb559f95ee0232e20550e28e4cfd3f6556cd8a8;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 438b9b5b..3a3a38bf 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,4 +1,4 @@ -
Readonly
[unscopables]Readonly
[unscopables]Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
@@ -128,50 +129,55 @@ when they will be absent when used in a 'with' statement.Optional
Readonly
[unscopables]?: booleanIs an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
-Optional
length?: booleanGets or sets the length of the array. This is a number one higher than the highest index in the array.
-Gets or sets the length of the array. This is a number one higher than the highest index in the array.
-Static
Readonly
[species]Static
Readonly
[species]Inherited from Array.[species]
Returns the item located at the specified index.
The zero-based index of the desired code unit. A negative index will count back from the last item.
-Inherited from Array.at
Private
checkPrivate
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
@@ -230,43 +238,48 @@ to the same array starting at position targetIf target is negative, it is treated as length+target where length is the length of the array.
-Optional
start: numberIf start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.
-0
is used.
+
+
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
Inherited from Array.entries
Determines whether all the members of an array satisfy the specified test.
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.
-Inherited from Array.every
Determines whether all the members of an array satisfy the specified test.
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.
-Inherited from Array.every
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.
-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.
-Inherited from Array.filter
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.
-Inherited from Array.filter
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
@@ -471,6 +500,7 @@ otherwise. 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.
-Inherited from Array.find
Inherited from Array.find
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
@@ -540,6 +572,7 @@ otherwise. 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.
-Inherited from Array.findIndex
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
@@ -587,15 +622,17 @@ specified depth.Optional
depth: DThe maximum recursion depth
-Inherited from Array.flat
Calls a defined callback function on each element of an array. Then, flattens the result into a new array. @@ -616,6 +653,7 @@ 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.
-Inherited from Array.flatMap
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.
-Inherited from Array.forEach
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.
-Inherited from Array.includes
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.
-Inherited from Array.indexOf
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.
-Inherited from Array.join
Returns an iterable of keys in the array
Inherited from Array.keys
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.
-Inherited from Array.lastIndexOf
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.
-Inherited from Array.map
Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Inherited from Array.pop
Rest
...items: T[]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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
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.
-Inherited from Array.reduce
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.
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.
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.
-Inherited from Array.reduceRight
Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Inherited from Array.shift
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. @@ -1117,20 +1188,23 @@ 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.
-Inherited from Array.slice
Determines whether the specified callback function returns true for any element of an 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.some
Sorts an array in place. This method mutates the array and returns a reference to the same array.
@@ -1186,6 +1263,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact[11,2,22,1].sort((a, b) => a - b)
Inherited from Array.sort
Optional
deleteCount: numberRest
...items: T[]Overrides Array.splice
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
Inherited from Array.toLocaleString
Rest
...items: T[]Overrides Array.unshift
Static
fromStatic
fromCreates an array from an array-like object.
An array-like object to convert to an array.
-Inherited from Array.from
Creates an array from an iterable object.
An array-like object to convert to an array.
-A mapping function to call on every element of the array.
Optional
thisArg: anyValue of 'this' used to invoke the mapfn.
-Inherited from Array.from
Creates an array from an iterable object.
An iterable object to convert to an array.
-Inherited from Array.from
Creates an array from an iterable object.
An iterable object to convert to an array.
-A mapping function to call on every element of the array.
Optional
thisArg: anyValue of 'this' used to invoke the mapfn.
-Inherited from Array.from
Static
isStatic
isInherited from Array.isArray
Static
ofStatic
ofInherited from Array.of
Generated using TypeDoc
Array with a maximum length and shifting items when full.
-