FindFilteredLabelSelectorResponse<T>
Response type for findFiltered when using label selector mode.
Aligns with the response type of the underlying findMatching store action via findLabelSelector.
Can be either a transient response object (with data and pagination) or an array of resources.
Type Parameters
T
T = Record<string, any>
Indexable
[n: number]: T
Properties
[unscopables]
readonly [unscopables]: object;
Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Index Signature
[key: number]: boolean
| Name | Type | Description |
|---|---|---|
|
| ‐ |
|
| Is an object whose properties have the value 'true' 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. |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
|
| ‐ |
length
length: number;
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
Methods
[iterator]()
iterator: ArrayIterator<T>;
Iterator
Returns
ArrayIterator<T>
concat()
Call Signature
concat(...items): T[];
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
items
...ConcatArray<T>[]
Additional arrays and/or items to add to the end of the array.
Returns
T[]
Call Signature
concat(...items): T[];
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
items
...(T | ConcatArray<T>)[]
Additional arrays and/or items to add to the end of the array.
Returns
T[]
copyWithin()
copyWithin(
target,
start,
end?): this;
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.
end?
number
If not specified, length of the this object is used as its default value.
Returns
this
entries()
entries(): ArrayIterator<[number, T]>;
Returns an iterable of key, value pairs for every entry in the array
Returns
ArrayIterator<[number, T]>
every()
Call Signature
every<S>(predicate, thisArg?): this is S[];
Determines whether all the members of an array satisfy the specified test.
Type Parameters
S
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 which is coercible to the Boolean value false, or until the end of the array.
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.
Returns
this is S[]
Call Signature
every(predicate, thisArg?): boolean;
Determines whether all the members of an array satisfy the specified test.
Parameters
predicate
(value, index, array) => unknown
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.
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.
Returns
boolean
fill()
fill(
value,
start?,
end?): this;
Changes all array elements from start to end index to a static value and returns the modified array
Parameters
value
T
value to fill array section with
start?
number
index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
end?
number
index to stop filling the array at. If end is negative, it is treated as length+end.
Returns
this
filter()
Call Signature
filter<S>(predicate, thisArg?): S[];
Returns the elements of an array that meet the condition specified in a callback function.
Type Parameters
S
S
Parameters
predicate
(value, index, array) => value is S
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
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.
Returns
S[]
Call Signature
filter(predicate, thisArg?): T[];
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
predicate
(value, index, array) => unknown
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
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.
Returns
T[]
find()
Call Signature
find<S>(predicate, thisArg?): S;
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Type Parameters
S
S
Parameters
predicate
(value, index, obj) => value is S
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.
thisArg?
any
If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns
S
Call Signature
find(predicate, thisArg?): T;
Parameters
predicate
(value, index, obj) => unknown
thisArg?
any
Returns
T
findIndex()
findIndex(predicate, thisArg?): number;
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
predicate
(value, index, obj) => unknown
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.
thisArg?
any
If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns
number
forEach()
forEach(callbackfn, thisArg?): void;
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.
thisArg?
any
An 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
indexOf()
indexOf(searchElement, fromIndex?): number;
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
Parameters
searchElement
T
The value to locate in the array.
fromIndex?
number
The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns
number
join()
join(separator?): string;
Adds all the elements of an array into a string, separated by the specified separator string.
Parameters
separator?
string
A 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
string
keys()
keys(): ArrayIterator<number>;
Returns an iterable of keys in the array
Returns
ArrayIterator<number>
lastIndexOf()
lastIndexOf(searchElement, fromIndex?): number;
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
Parameters
searchElement
T
The value to locate in the array.
fromIndex?
number
The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
Returns
number
map()
map<U>(callbackfn, thisArg?): U[];
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Type Parameters
U
U
Parameters
callbackfn
(value, index, array) => U
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
thisArg?
any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns
U[]
pop()
pop(): T;
Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Returns
T
push()
push(...items): number;
Appends new elements to the end of an array, and returns the new length of the array.
Parameters
items
...T[]
New elements to add to the array.
Returns
number
reduce()
Call Signature
reduce(callbackfn): 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.
Parameters
callbackfn
(previousValue, currentValue, currentIndex, array) => T
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns
T
Call Signature
reduce(callbackfn, initialValue): T;
Parameters
callbackfn
(previousValue, currentValue, currentIndex, array) => T
initialValue
T
Returns
T
Call Signature
reduce<U>(callbackfn, initialValue): U;
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.
Type Parameters
U
U
Parameters
callbackfn
(previousValue, currentValue, currentIndex, array) => U
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue
U
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.
Returns
U
reduceRight()
Call Signature
reduceRight(callbackfn): T;
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.
Parameters
callbackfn
(previousValue, currentValue, currentIndex, array) => T
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Returns
T
Call Signature
reduceRight(callbackfn, initialValue): T;
Parameters
callbackfn
(previousValue, currentValue, currentIndex, array) => T
initialValue
T
Returns
T
Call Signature
reduceRight<U>(callbackfn, initialValue): U;
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.
Type Parameters
U
U
Parameters
callbackfn
(previousValue, currentValue, currentIndex, array) => U
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue
U
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.
Returns
U
reverse()
reverse(): T[];
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
Returns
T[]
shift()
shift(): T;
Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Returns
T
slice()
slice(start?, end?): T[];
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.
Parameters
start?
number
The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
end?
number
The 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.
Returns
T[]
some()
some(predicate, thisArg?): boolean;
Determines whether the specified callback function returns true for any element of an array.
Parameters
predicate
(value, index, array) => unknown
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.
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.
Returns
boolean
sort()
sort(compareFn?): this;
Sorts an array in place. This method mutates the array and returns a reference to the same array.
Parameters
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, UTF-16 code unit order.
[11,2,22,1].sort((a, b) => a - b)
Returns
this
splice()
Call Signature
splice(start, deleteCount?): T[];
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start
number
The zero-based location in the array from which to start removing elements.
deleteCount?
number
The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.
Returns
T[]
An array containing the elements that were deleted.
Call Signature
splice(
start,
deleteCount, ...
items): T[];
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start
number
The zero-based location in the array from which to start removing elements.
deleteCount
number
The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.
items
...T[]
Elements to insert into the array in place of the deleted elements.
Returns
T[]
An array containing the elements that were deleted.
toLocaleString()
Call Signature
toLocaleString(): string;
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
Returns
string
Call Signature
toLocaleString(locales, options?): string;
Parameters
locales
string | string[]
options?
NumberFormatOptions & DateTimeFormatOptions
Returns
string
toString()
toString(): string;
Returns a string representation of an array.
Returns
string
unshift()
unshift(...items): number;
Inserts new elements at the start of an array, and returns the new length of the array.
Parameters
items
...T[]
Elements to insert at the start of the array.
Returns
number
values()
values(): ArrayIterator<T>;
Returns an iterable of values in the array
Returns
ArrayIterator<T>