X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FCircularArray.html;h=3c0753f8653273f8f7e12ecda068ab15828b2e05;hb=b4c2a50df77a5f3110d228436ce9f3008cbd8297;hp=802a35033e8efca5522efa2477eaf11086fc5123;hpb=557991e8ddb66a72a47d62606e142e8be86677f2;p=poolifier.git diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 802a3503..3c0753f8 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,4 +1,4 @@ -
Internal
Rest
...items: T[]Rest
...items: T[]Rest
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.
-Inherited from Array.length
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>)[]Rest
...items: (T | ConcatArray<T>)[]Rest
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
@@ -239,34 +246,36 @@ is treated as length+end.Optional
end: numberIf not specified, length of the this object is used as its default value.
-Optional
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.
-Optional
+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.
-Optional
+Inherited from Array.every
Changes all array elements from start
to end
index to a static value
and returns the modified array
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
Optional
end: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
-Optional
+Inherited from Array.fill
Returns the elements of an array that meet the condition specified in a callback function.
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.
-Optional
+Inherited from Array.filter
Returns the elements of an array that meet the condition specified in a callback function.
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.
-Optional
+Inherited from Array.filter
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
@@ -490,12 +504,13 @@ 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
Inherited from Array.find
Optional
thisArg: anyOptional
thisArg: anyOptional
Inherited from Array.find
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
@@ -559,15 +574,16 @@ findIndex immediately returns that element index. Otherwise, findIndex returns -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
Inherited from Array.findIndex
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
@@ -587,15 +603,16 @@ specified depth.Optional
depth: DThe maximum recursion depth
-Optional
Inherited from Array.flat
Calls a defined callback function on each element of an array. Then, flattens the result into a new array. @@ -637,15 +654,16 @@ 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.
-Optional
Inherited from Array.flatMap
Performs the specified action for each element in an 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.
-Optional
+Inherited from Array.forEach
Determines whether an array includes a certain element, returning true or false as appropriate.
Optional
fromIndex: numberThe position in this array at which to begin searching for searchElement.
-Optional
+Inherited from Array.includes
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
Optional
fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
-Optional
+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.
-Optional
+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.
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.
-Optional
+Inherited from Array.lastIndexOf
Calls a defined callback function on each element of an array, and returns an array that contains the results.
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.
-Optional
+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[]Rest
...items: T[]Rest
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.
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.
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.
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 +1149,21 @@ 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
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.
-Optional
+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.
-Optional
+Inherited from Array.some
Sorts an array in place. This method mutates the array and returns a reference to the same array.
@@ -1185,7 +1219,7 @@ 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
Inherited from Array.sort
Optional
deleteCount: numberOptional
deleteCount: numberOptional
Rest
...items: T[]Rest
...items: T[]Rest
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[]Rest
...items: T[]Rest
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.
Optional
thisArg: anyValue of 'this' used to invoke the mapfn.
-Optional
+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.
Optional
thisArg: anyValue of 'this' used to invoke the mapfn.
-Optional
+Inherited from Array.from
Static
isStatic
isInherited from Array.isArray
Static
ofStatic
ofRest
Inherited from Array.of
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Array with a maximum length and shifting items when full.
-