ConnectionTypeListResult interface
- Extends
-
Array<ConnectionType>
Properties
next |
Gets or sets the next link. |
Inherited Properties
length | Gets or sets the length of the array. This is a number one higher than the highest index in the array. |
Inherited Methods
at(number) | |
concat((Connection |
Combines two or more arrays. This method returns a new array without modifying any existing arrays. |
concat(Concat |
Combines two or more arrays. This method returns a new array without modifying any existing arrays. |
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 |
entries() | Returns an iterable of key, value pairs for every entry in the array |
every((value: Connection |
Determines whether all the members of an array satisfy the specified test. |
every<S>((value: Connection |
Determines whether all the members of an array satisfy the specified test. |
fill(Connection |
Changes all array elements from |
filter((value: Connection |
Returns the elements of an array that meet the condition specified in a callback function. |
filter<S>((value: Connection |
Returns the elements of an array that meet the condition specified in a callback function. |
find((value: Connection |
|
find<S>((this: void, value: Connection |
Returns the value of the first element in the array where predicate is true, and undefined otherwise. |
find |
Returns the index of the first element in the array where predicate is true, and -1 otherwise. |
flat<A, D>(A, D) | Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. |
flat |
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. |
for |
Performs the specified action for each element in an array. |
includes(Connection |
Determines whether an array includes a certain element, returning true or false as appropriate. |
index |
Returns the index of the first occurrence of a value in an array, or -1 if it is not present. |
join(string) | Adds all the elements of an array into a string, separated by the specified separator string. |
keys() | Returns an iterable of keys in the array |
last |
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. |
map<U>((value: Connection |
Calls a defined callback function on each element of an array, and returns an array that contains the results. |
pop() | Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. |
push(Connection |
Appends new elements to the end of an array, and returns the new length of the array. |
reduce((previous |
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. |
reduce((previous |
|
reduce<U>((previous |
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. |
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. |
reduce |
|
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. |
reverse() | Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array. |
shift() | Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. |
slice(number, number) | 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. |
some((value: Connection |
Determines whether the specified callback function returns true for any element of an array. |
sort((a: Connection |
Sorts an array in place. This method mutates the array and returns a reference to the same array. |
splice(number, number) | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. |
splice(number, number, Connection |
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. |
to |
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. |
to |
Returns a string representation of an array. |
unshift(Connection |
Inserts new elements at the start of an array, and returns the new length of the array. |
values() | Returns an iterable of values in the array |
[iterator]() | Iterator |
[unscopables]() | Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
Property Details
nextLink
Gets or sets the next link.
nextLink?: string
Property Value
string
Inherited Property Details
length
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
length: number
Property Value
number
Inherited From Array.length
Inherited Method Details
at(number)
function at(index: number): undefined | ConnectionType
Parameters
- index
-
number
Returns
undefined | ConnectionType
Inherited From Array.at
concat((ConnectionType | ConcatArray<ConnectionType>)[])
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
function concat(items: (ConnectionType | ConcatArray<ConnectionType>)[]): ConnectionType[]
Parameters
- items
-
(ConnectionType | ConcatArray<ConnectionType>)[]
Additional arrays and/or items to add to the end of the array.
Returns
Inherited From Array.concat
concat(ConcatArray<ConnectionType>[])
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
function concat(items: ConcatArray<ConnectionType>[]): ConnectionType[]
Parameters
- items
-
ConcatArray<ConnectionType>[]
Additional arrays and/or items to add to the end of the array.
Returns
Inherited From Array.concat
copyWithin(number, number, number)
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
function copyWithin(target: number, start: number, end?: number): ConnectionTypeListResult
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
Inherited From Array.copyWithin
entries()
Returns an iterable of key, value pairs for every entry in the array
function entries(): IterableIterator<[number, ConnectionType]>
Returns
IterableIterator<[number, ConnectionType]>
Inherited From Array.entries
every((value: ConnectionType, index: number, array: ConnectionType[]) => unknown, any)
Determines whether all the members of an array satisfy the specified test.
function every(predicate: (value: ConnectionType, index: number, array: ConnectionType[]) => unknown, thisArg?: any): boolean
Parameters
- predicate
-
(value: ConnectionType, index: number, array: ConnectionType[]) => 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
Inherited From Array.every
every<S>((value: ConnectionType, index: number, array: ConnectionType[]) => value, any)
Determines whether all the members of an array satisfy the specified test.
function every<S>(predicate: (value: ConnectionType, index: number, array: ConnectionType[]) => value, thisArg?: any): this
Parameters
- predicate
-
(value: ConnectionType, index: number, array: ConnectionType[]) => value
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
Inherited From Array.every
fill(ConnectionType, number, number)
Changes all array elements from start
to end
index to a static value
and returns the modified array
function fill(value: ConnectionType, start?: number, end?: number): ConnectionTypeListResult
Parameters
- value
- ConnectionType
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
Inherited From Array.fill
filter((value: ConnectionType, index: number, array: ConnectionType[]) => unknown, any)
Returns the elements of an array that meet the condition specified in a callback function.
function filter(predicate: (value: ConnectionType, index: number, array: ConnectionType[]) => unknown, thisArg?: any): ConnectionType[]
Parameters
- predicate
-
(value: ConnectionType, index: number, array: ConnectionType[]) => 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
Inherited From Array.filter
filter<S>((value: ConnectionType, index: number, array: ConnectionType[]) => value, any)
Returns the elements of an array that meet the condition specified in a callback function.
function filter<S>(predicate: (value: ConnectionType, index: number, array: ConnectionType[]) => value, thisArg?: any): S[]
Parameters
- predicate
-
(value: ConnectionType, index: number, array: ConnectionType[]) => value
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[]
Inherited From Array.filter
find((value: ConnectionType, index: number, obj: ConnectionType[]) => unknown, any)
function find(predicate: (value: ConnectionType, index: number, obj: ConnectionType[]) => unknown, thisArg?: any): undefined | ConnectionType
Parameters
- predicate
-
(value: ConnectionType, index: number, obj: ConnectionType[]) => unknown
- thisArg
-
any
Returns
undefined | ConnectionType
Inherited From Array.find
find<S>((this: void, value: ConnectionType, index: number, obj: ConnectionType[]) => value, any)
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
function find<S>(predicate: (this: void, value: ConnectionType, index: number, obj: ConnectionType[]) => value, thisArg?: any): undefined | S
Parameters
- predicate
-
(this: void, value: ConnectionType, index: number, obj: ConnectionType[]) => value
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
undefined | S
Inherited From Array.find
findIndex((value: ConnectionType, index: number, obj: ConnectionType[]) => unknown, any)
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
function findIndex(predicate: (value: ConnectionType, index: number, obj: ConnectionType[]) => unknown, thisArg?: any): number
Parameters
- predicate
-
(value: ConnectionType, index: number, obj: ConnectionType[]) => 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
Inherited From Array.findIndex
flat<A, D>(A, D)
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
function flat<A, D>(this: A, depth?: D): FlatArray<A, D>[]
Parameters
- this
-
A
- depth
-
D
The maximum recursion depth
Returns
FlatArray<A, D>[]
Inherited From Array.flat
flatMap<U, This>((this: This, value: ConnectionType, index: number, array: ConnectionType[]) => U | (readonly U[]), This)
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.
function flatMap<U, This>(callback: (this: This, value: ConnectionType, index: number, array: ConnectionType[]) => U | (readonly U[]), thisArg?: This): U[]
Parameters
- callback
-
(this: This, value: ConnectionType, index: number, array: ConnectionType[]) => U | (readonly U[])
A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
- thisArg
-
This
An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.
Returns
U[]
Inherited From Array.flatMap
forEach((value: ConnectionType, index: number, array: ConnectionType[]) => void, any)
Performs the specified action for each element in an array.
function forEach(callbackfn: (value: ConnectionType, index: number, array: ConnectionType[]) => void, thisArg?: any)
Parameters
- callbackfn
-
(value: ConnectionType, index: number, array: ConnectionType[]) => 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.
Inherited From Array.forEach
includes(ConnectionType, number)
Determines whether an array includes a certain element, returning true or false as appropriate.
function includes(searchElement: ConnectionType, fromIndex?: number): boolean
Parameters
- searchElement
- ConnectionType
The element to search for.
- fromIndex
-
number
The position in this array at which to begin searching for searchElement.
Returns
boolean
Inherited From Array.includes
indexOf(ConnectionType, number)
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
function indexOf(searchElement: ConnectionType, fromIndex?: number): number
Parameters
- searchElement
- ConnectionType
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
Inherited From Array.indexOf
join(string)
Adds all the elements of an array into a string, separated by the specified separator string.
function join(separator?: string): 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
Inherited From Array.join
keys()
Returns an iterable of keys in the array
function keys(): IterableIterator<number>
Returns
IterableIterator<number>
Inherited From Array.keys
lastIndexOf(ConnectionType, number)
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
function lastIndexOf(searchElement: ConnectionType, fromIndex?: number): number
Parameters
- searchElement
- ConnectionType
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
Inherited From Array.lastIndexOf
map<U>((value: ConnectionType, index: number, array: ConnectionType[]) => U, any)
Calls a defined callback function on each element of an array, and returns an array that contains the results.
function map<U>(callbackfn: (value: ConnectionType, index: number, array: ConnectionType[]) => U, thisArg?: any): U[]
Parameters
- callbackfn
-
(value: ConnectionType, index: number, array: ConnectionType[]) => 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[]
Inherited From Array.map
pop()
Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
function pop(): undefined | ConnectionType
Returns
undefined | ConnectionType
Inherited From Array.pop
push(ConnectionType[])
Appends new elements to the end of an array, and returns the new length of the array.
function push(items: ConnectionType[]): number
Parameters
- items
New elements to add to the array.
Returns
number
Inherited From Array.push
reduce((previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType)
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.
function reduce(callbackfn: (previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType): ConnectionType
Parameters
- callbackfn
-
(previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns
Inherited From Array.reduce
reduce((previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType, ConnectionType)
function reduce(callbackfn: (previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType, initialValue: ConnectionType): ConnectionType
Parameters
- callbackfn
-
(previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType
- initialValue
- ConnectionType
Returns
Inherited From Array.reduce
reduce<U>((previousValue: U, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => U, 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.
function reduce<U>(callbackfn: (previousValue: U, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => U, initialValue: U): U
Parameters
- callbackfn
-
(previousValue: U, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => 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
Inherited From Array.reduce
reduceRight((previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType)
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.
function reduceRight(callbackfn: (previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType): ConnectionType
Parameters
- callbackfn
-
(previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Returns
Inherited From Array.reduceRight
reduceRight((previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType, ConnectionType)
function reduceRight(callbackfn: (previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType, initialValue: ConnectionType): ConnectionType
Parameters
- callbackfn
-
(previousValue: ConnectionType, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => ConnectionType
- initialValue
- ConnectionType
Returns
Inherited From Array.reduceRight
reduceRight<U>((previousValue: U, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => U, 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.
function reduceRight<U>(callbackfn: (previousValue: U, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => U, initialValue: U): U
Parameters
- callbackfn
-
(previousValue: U, currentValue: ConnectionType, currentIndex: number, array: ConnectionType[]) => 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
Inherited From Array.reduceRight
reverse()
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
function reverse(): ConnectionType[]
Returns
Inherited From Array.reverse
shift()
Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
function shift(): undefined | ConnectionType
Returns
undefined | ConnectionType
Inherited From Array.shift
slice(number, number)
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.
function slice(start?: number, end?: number): ConnectionType[]
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
Inherited From Array.slice
some((value: ConnectionType, index: number, array: ConnectionType[]) => unknown, any)
Determines whether the specified callback function returns true for any element of an array.
function some(predicate: (value: ConnectionType, index: number, array: ConnectionType[]) => unknown, thisArg?: any): boolean
Parameters
- predicate
-
(value: ConnectionType, index: number, array: ConnectionType[]) => 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
Inherited From Array.some
sort((a: ConnectionType, b: ConnectionType) => number)
Sorts an array in place. This method mutates the array and returns a reference to the same array.
function sort(compareFn?: (a: ConnectionType, b: ConnectionType) => number): ConnectionTypeListResult
Parameters
- compareFn
-
(a: ConnectionType, b: ConnectionType) => 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)
Returns
Inherited From Array.sort
splice(number, number)
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
function splice(start: number, deleteCount?: number): ConnectionType[]
Parameters
- start
-
number
The zero-based location in the array from which to start removing elements.
- deleteCount
-
number
The number of elements to remove.
Returns
An array containing the elements that were deleted.
Inherited From Array.splice
splice(number, number, ConnectionType[])
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
function splice(start: number, deleteCount: number, items: ConnectionType[]): ConnectionType[]
Parameters
- start
-
number
The zero-based location in the array from which to start removing elements.
- deleteCount
-
number
The number of elements to remove.
- items
Elements to insert into the array in place of the deleted elements.
Returns
An array containing the elements that were deleted.
Inherited From Array.splice
toLocaleString()
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
function toLocaleString(): string
Returns
string
Inherited From Array.toLocaleString
toString()
Returns a string representation of an array.
function toString(): string
Returns
string
Inherited From Array.toString
unshift(ConnectionType[])
Inserts new elements at the start of an array, and returns the new length of the array.
function unshift(items: ConnectionType[]): number
Parameters
- items
Elements to insert at the start of the array.
Returns
number
Inherited From Array.unshift
values()
Returns an iterable of values in the array
function values(): IterableIterator<ConnectionType>
Returns
IterableIterator<ConnectionType>
Inherited From Array.values
[iterator]()
Iterator
function [iterator](): IterableIterator<ConnectionType>
Returns
IterableIterator<ConnectionType>
Inherited From Array.__@iterator@1503
[unscopables]()
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
function [unscopables](): { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean }
Returns
{ copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean }
Inherited From Array.__@unscopables@1505