Class: default<EntityName>
_internals/data/EntityCollection.default
Type parameters
| Name | Type |
|---|---|
EntityName | extends keyof Entities |
Hierarchy
Array<Entity<EntityName>>↳
default
Constructors
constructor
• new default<EntityName>(source, entityName, context, criteria?, entities?, total?, aggregations?)
Type parameters
| Name | Type |
|---|---|
EntityName | extends keyof Entities |
Parameters
| Name | Type | Default value |
|---|---|---|
source | string | undefined |
entityName | EntityName | undefined |
context | ApiContext | undefined |
criteria | null | default | null |
entities | Entity<EntityName>[] | [] |
total | null | number | null |
aggregations | null | string[] | null |
Overrides
Array<Entity<EntityName\>\>.constructor
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:65
Properties
entity
• entity: EntityName
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:31
source
• source: string
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:33
context
• context: ApiContext
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:35
criteria
• criteria: null | default
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:37
aggregations
• aggregations: null | string[]
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:39
total
• total: null | number
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:41
first
• first: () => null | Entity<EntityName>
Type declaration
▸ (): null | Entity<EntityName>
Returns
null | Entity<EntityName>
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:43
last
• last: () => null | Entity<EntityName>
Type declaration
▸ (): null | Entity<EntityName>
Returns
null | Entity<EntityName>
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:45
remove
• remove: (id: string) => boolean
Type declaration
▸ (id): boolean
Parameters
| Name | Type |
|---|---|
id | string |
Returns
boolean
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:47
has
• has: (id: string) => boolean
Type declaration
▸ (id): boolean
Parameters
| Name | Type |
|---|---|
id | string |
Returns
boolean
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:49
get
• get: (id: string) => null | Entity<EntityName>
Type declaration
▸ (id): null | Entity<EntityName>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
null | Entity<EntityName>
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:51
getAt
• getAt: (index: number) => null | Entity<EntityName>
Type declaration
▸ (index): null | Entity<EntityName>
Parameters
| Name | Type |
|---|---|
index | number |
Returns
null | Entity<EntityName>
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:53
getIds
• getIds: () => string[]
Type declaration
▸ (): string[]
Returns
string[]
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:55
add
• add: (e: Entity<EntityName>) => void
Type declaration
▸ (e): void
Parameters
| Name | Type |
|---|---|
e | Entity<EntityName> |
Returns
void
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:57
addAt
• addAt: (e: Entity<EntityName>, indexAt: number) => void
Type declaration
▸ (e, indexAt): void
Parameters
| Name | Type |
|---|---|
e | Entity<EntityName> |
indexAt | number |
Returns
void
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:59
moveItem
• moveItem: (oldIndex: number, newIndex: number) => null | Entity<EntityName>
Type declaration
▸ (oldIndex, newIndex): null | Entity<EntityName>
Parameters
| Name | Type |
|---|---|
oldIndex | number |
newIndex | number |
Returns
null | Entity<EntityName>
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:61
__identifier__
• __identifier__: () => string
Type declaration
▸ (): string
Returns
string
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:63
length
• length: number
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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1304
[species]
▪ Static Readonly [species]: ArrayConstructor
Inherited from
Array.__@species@1638
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:314
Methods
toString
▸ toString(): string
Returns a string representation of an array.
Returns
string
Inherited from
Array.toString
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1308
toLocaleString
▸ toLocaleString(): string
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
Returns
string
Inherited from
Array.toLocaleString
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1312
pop
▸ pop(): undefined | Entity<EntityName>
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
undefined | Entity<EntityName>
Inherited from
Array.pop
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1317
push
▸ push(...items): number
Appends new elements to the end of an array, and returns the new length of the array.
Parameters
| Name | Type | Description |
|---|---|---|
...items | Entity<EntityName>[] | New elements to add to the array. |
Returns
number
Inherited from
Array.push
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1322
concat
▸ concat(...items): Entity<EntityName>[]
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
| Name | Type | Description |
|---|---|---|
...items | ConcatArray<Entity<EntityName>>[] | Additional arrays and/or items to add to the end of the array. |
Returns
Entity<EntityName>[]
Inherited from
Array.concat
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1328
▸ concat(...items): Entity<EntityName>[]
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
| Name | Type | Description |
|---|---|---|
...items | (Entity<EntityName> | ConcatArray<Entity<EntityName>>)[] | Additional arrays and/or items to add to the end of the array. |
Returns
Entity<EntityName>[]
Inherited from
Array.concat
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1334
join
▸ join(separator?): string
Adds all the elements of an array into a string, separated by the specified separator string.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1339
reverse
▸ reverse(): Entity<EntityName>[]
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
Returns
Entity<EntityName>[]
Inherited from
Array.reverse
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1344
shift
▸ shift(): undefined | Entity<EntityName>
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
undefined | Entity<EntityName>
Inherited from
Array.shift
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1349
slice
▸ slice(start?, end?): Entity<EntityName>[]
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
| Name | Type | Description |
|---|---|---|
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
Entity<EntityName>[]
Inherited from
Array.slice
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1359
sort
▸ sort(compareFn?): default<EntityName>
Sorts an array in place. This method mutates the array and returns a reference to the same array.
Parameters
| Name | Type | Description |
|---|---|---|
compareFn? | (a: Entity<EntityName>, b: Entity<EntityName>) => 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. ts [11,2,22,1].sort((a, b) => a - b) |
Returns
default<EntityName>
Inherited from
Array.sort
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1370
splice
▸ splice(start, deleteCount?): Entity<EntityName>[]
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
| Name | Type | Description |
|---|---|---|
start | number | The zero-based location in the array from which to start removing elements. |
deleteCount? | number | The number of elements to remove. |
Returns
Entity<EntityName>[]
An array containing the elements that were deleted.
Inherited from
Array.splice
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1377
▸ splice(start, deleteCount, ...items): Entity<EntityName>[]
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
| Name | Type | Description |
|---|---|---|
start | number | The zero-based location in the array from which to start removing elements. |
deleteCount | number | The number of elements to remove. |
...items | Entity<EntityName>[] | Elements to insert into the array in place of the deleted elements. |
Returns
Entity<EntityName>[]
An array containing the elements that were deleted.
Inherited from
Array.splice
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1385
unshift
▸ unshift(...items): number
Inserts new elements at the start of an array, and returns the new length of the array.
Parameters
| Name | Type | Description |
|---|---|---|
...items | Entity<EntityName>[] | Elements to insert at the start of the array. |
Returns
number
Inherited from
Array.unshift
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1390
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
| Name | Type | Description |
|---|---|---|
searchElement | Entity<EntityName> | 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1396
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
| Name | Type | Description |
|---|---|---|
searchElement | Entity<EntityName> | 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1402
every
▸ every<S>(predicate, thisArg?): this is S[]
Determines whether all the members of an array satisfy the specified test.
Type parameters
| Name | Type |
|---|---|
S | extends Object |
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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[]
Inherited from
Array.every
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1411
▸ every(predicate, thisArg?): boolean
Determines whether all the members of an array satisfy the specified test.
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1420
some
▸ some(predicate, thisArg?): boolean
Determines whether the specified callback function returns true for any element of an array.
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1429
forEach
▸ forEach(callbackfn, thisArg?): void
Performs the specified action for each element in an array.
Parameters
| Name | Type | Description |
|---|---|---|
callbackfn | (value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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
Inherited from
Array.forEach
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1435
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
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
callbackfn | (value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1441
filter
▸ filter<S>(predicate, thisArg?): S[]
Returns the elements of an array that meet the condition specified in a callback function.
Type parameters
| Name | Type |
|---|---|
S | extends Object |
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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[]
Inherited from
Array.filter
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1447
▸ filter(predicate, thisArg?): Entity<EntityName>[]
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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
Entity<EntityName>[]
Inherited from
Array.filter
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1453
reduce
▸ reduce(callbackfn): Entity<EntityName>
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
| Name | Type | Description |
|---|---|---|
callbackfn | (previousValue: Entity<EntityName>, currentValue: Entity<EntityName>, currentIndex: number, array: Entity<EntityName>[]) => Entity<EntityName> | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
Returns
Entity<EntityName>
Inherited from
Array.reduce
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1459
▸ reduce(callbackfn, initialValue): Entity<EntityName>
Parameters
| Name | Type |
|---|---|
callbackfn | (previousValue: Entity<EntityName>, currentValue: Entity<EntityName>, currentIndex: number, array: Entity<EntityName>[]) => Entity<EntityName> |
initialValue | Entity<EntityName> |
Returns
Entity<EntityName>
Inherited from
Array.reduce
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1460
▸ 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
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
callbackfn | (previousValue: U, currentValue: Entity<EntityName>, currentIndex: number, array: Entity<EntityName>[]) => 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1466
reduceRight
▸ reduceRight(callbackfn): Entity<EntityName>
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
| Name | Type | Description |
|---|---|---|
callbackfn | (previousValue: Entity<EntityName>, currentValue: Entity<EntityName>, currentIndex: number, array: Entity<EntityName>[]) => Entity<EntityName> | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |
Returns
Entity<EntityName>
Inherited from
Array.reduceRight
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1472
▸ reduceRight(callbackfn, initialValue): Entity<EntityName>
Parameters
| Name | Type |
|---|---|
callbackfn | (previousValue: Entity<EntityName>, currentValue: Entity<EntityName>, currentIndex: number, array: Entity<EntityName>[]) => Entity<EntityName> |
initialValue | Entity<EntityName> |
Returns
Entity<EntityName>
Inherited from
Array.reduceRight
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1473
▸ 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
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
callbackfn | (previousValue: U, currentValue: Entity<EntityName>, currentIndex: number, array: Entity<EntityName>[]) => 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1479
find
▸ find<S>(predicate, thisArg?): undefined | S
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Type parameters
| Name | Type |
|---|---|
S | extends Object |
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (this: void, value: Entity<EntityName>, index: number, obj: Entity<EntityName>[]) => 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
undefined | S
Inherited from
Array.find
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:31
▸ find(predicate, thisArg?): undefined | Entity<EntityName>
Parameters
| Name | Type |
|---|---|
predicate | (value: Entity<EntityName>, index: number, obj: Entity<EntityName>[]) => unknown |
thisArg? | any |
Returns
undefined | Entity<EntityName>
Inherited from
Array.find
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:32
findIndex
▸ findIndex(predicate, thisArg?): number
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
| Name | Type | Description |
|---|---|---|
predicate | (value: Entity<EntityName>, index: number, obj: Entity<EntityName>[]) => 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:43
fill
▸ fill(value, start?, end?): default<EntityName>
Changes all array elements from start to end index to a static value and returns the modified array
Parameters
| Name | Type | Description |
|---|---|---|
value | Entity<EntityName> | 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
default<EntityName>
Inherited from
Array.fill
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:53
copyWithin
▸ copyWithin(target, start, end?): default<EntityName>
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
| Name | Type | Description |
|---|---|---|
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
default<EntityName>
Inherited from
Array.copyWithin
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:64
entries
▸ entries(): IterableIterator<[number, Entity<EntityName>]>
Returns an iterable of key, value pairs for every entry in the array
Returns
IterableIterator<[number, Entity<EntityName>]>
Inherited from
Array.entries
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.iterable.d.ts:65
keys
▸ keys(): IterableIterator<number>
Returns an iterable of keys in the array
Returns
IterableIterator<number>
Inherited from
Array.keys
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.iterable.d.ts:70
values
▸ values(): IterableIterator<Entity<EntityName>>
Returns an iterable of values in the array
Returns
IterableIterator<Entity<EntityName>>
Inherited from
Array.values
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.iterable.d.ts:75
includes
▸ includes(searchElement, fromIndex?): boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
| Name | Type | Description |
|---|---|---|
searchElement | Entity<EntityName> | 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
flatMap
▸ flatMap<U, This>(callback, thisArg?): U[]
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.
Type parameters
| Name | Type |
|---|---|
U | U |
This | undefined |
Parameters
| Name | Type | Description |
|---|---|---|
callback | (this: This, value: Entity<EntityName>, index: number, array: Entity<EntityName>[]) => 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
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2019.array.d.ts:70
flat
▸ flat<A, D>(this, depth?): FlatArray<A, D>[]
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters
| Name | Type |
|---|---|
A | A |
D | extends number = 1 |
Parameters
| Name | Type | Description |
|---|---|---|
this | A | - |
depth? | D | The maximum recursion depth |
Returns
FlatArray<A, D>[]
Inherited from
Array.flat
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2019.array.d.ts:81
at
▸ at(index): undefined | Entity<EntityName>
Returns the item located at the specified index.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The zero-based index of the desired code unit. A negative index will count back from the last item. |
Returns
undefined | Entity<EntityName>
Inherited from
Array.at
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2022.array.d.ts:26
[iterator]
▸ [iterator](): IterableIterator<Entity<EntityName>>
Iterator
Returns
IterableIterator<Entity<EntityName>>
Inherited from
Array.__@iterator@519
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.iterable.d.ts:60
[unscopables]
▸ [unscopables](): Object
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Returns
Object
| Name | Type |
|---|---|
copyWithin | boolean |
entries | boolean |
fill | boolean |
find | boolean |
findIndex | boolean |
keys | boolean |
values | boolean |
Inherited from
Array.__@unscopables@1301
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:99
fromCollection
▸ Static fromCollection<StaticEntityName>(collection): default<StaticEntityName>
Returns a new collection from given one with
Type parameters
| Name | Type |
|---|---|
StaticEntityName | extends keyof Entities |
Parameters
| Name | Type |
|---|---|
collection | default<StaticEntityName> |
Returns
default<StaticEntityName>
Defined in
packages/admin-sdk/src/_internals/data/EntityCollection.ts:258
isArray
▸ Static isArray(arg): arg is any[]
Parameters
| Name | Type |
|---|---|
arg | any |
Returns
arg is any[]
Inherited from
Array.isArray
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es5.d.ts:1491
from
▸ Static from<T>(arrayLike): T[]
Creates an array from an array-like object.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
arrayLike | ArrayLike<T> | An array-like object to convert to an array. |
Returns
T[]
Inherited from
Array.from
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:72
▸ Static from<T, U>(arrayLike, mapfn, thisArg?): U[]
Creates an array from an iterable object.
Type parameters
| Name |
|---|
T |
U |
Parameters
| Name | Type | Description |
|---|---|---|
arrayLike | ArrayLike<T> | An array-like object to convert to an array. |
mapfn | (v: T, k: number) => U | A mapping function to call on every element of the array. |
thisArg? | any | Value of 'this' used to invoke the mapfn. |
Returns
U[]
Inherited from
Array.from
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:80
▸ Static from<T>(iterable): T[]
Creates an array from an iterable object.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
iterable | Iterable<T> | ArrayLike<T> | An iterable object to convert to an array. |
Returns
T[]
Inherited from
Array.from
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.iterable.d.ts:83
▸ Static from<T, U>(iterable, mapfn, thisArg?): U[]
Creates an array from an iterable object.
Type parameters
| Name |
|---|
T |
U |
Parameters
| Name | Type | Description |
|---|---|---|
iterable | Iterable<T> | ArrayLike<T> | An iterable object to convert to an array. |
mapfn | (v: T, k: number) => U | A mapping function to call on every element of the array. |
thisArg? | any | Value of 'this' used to invoke the mapfn. |
Returns
U[]
Inherited from
Array.from
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.iterable.d.ts:91
of
▸ Static of<T>(...items): T[]
Returns a new array from a set of elements.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
...items | T[] | A set of elements to include in the new array object. |
Returns
T[]
Inherited from
Array.of
Defined in
packages/admin-sdk/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:86