Class: ModelLinksSimpleArray<T>
Link to a collection of objects
Extends
Array<ModelRef<T>>
Type parameters
• T extends CoreModel
Implements
Constructors
new ModelLinksSimpleArray(model, content, parent)
new ModelLinksSimpleArray<
T>(model,content,parent?):ModelLinksSimpleArray<T>
Parameters
• model: CoreModelDefinition<T>
• content: any[]= []
• parent?: CoreModel
Returns
Overrides
Array<ModelRef<T>>.constructor
Source
packages/core/src/models/relations.ts:128
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.
Type declaration
[unscopables]?
readonly[unscopables]?:boolean
Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
length?
length?:
boolean
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
[iterator]?
[iterator]?
at?
at?
concat?
concat?
copyWithin?
copyWithin?
entries?
entries?
every?
every?
fill?
fill?
filter?
filter?
find?
find?
findIndex?
findIndex?
flat?
flat?
flatMap?
flatMap?
forEach?
forEach?
includes?
includes?
indexOf?
indexOf?
join?
join?
keys?
keys?
lastIndexOf?
lastIndexOf?
map?
map?
pop?
pop?
push?
push?
reduce?
reduce?
reduceRight?
reduceRight?
reverse?
reverse?
shift?
shift?
slice?
slice?
some?
some?
sort?
sort?
splice?
splice?
toLocaleString?
toLocaleString?
toString?
toString?
unshift?
unshift?
values?
values?
Inherited from
Array.[unscopables]
Source
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
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
Source
node_modules/typescript/lib/lib.es5.d.ts:1325
model
protectedmodel:CoreModelDefinition<T>
Source
packages/core/src/models/relations.ts:129
[species]
staticreadonly[species]:ArrayConstructor
Inherited from
Array.[species]
Source
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
Methods
[iterator]()
[iterator]():
IterableIterator<ModelRef<T>>
Iterator
Returns
IterableIterator<ModelRef<T>>
Inherited from
Array.[iterator]
Source
node_modules/typescript/lib/lib.es2015.iterable.d.ts:58
add()
add(
model):void
Parameters
• model: string | T | ModelRef<T>
Returns
void
Source
packages/core/src/models/relations.ts:138
at()
at(
index):ModelRef<T>
Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.
Parameters
• index: number
Returns
ModelRef<T>
Inherited from
Array.at
Source
packages/core/node_modules/@types/node/globals.d.ts:91
concat()
concat(items)
concat(...
items):ModelRef<T>[]
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
• ...items: ConcatArray<ModelRef<T>>[]
Additional arrays and/or items to add to the end of the array.
Returns
ModelRef<T>[]
Inherited from
Array.concat
Source
node_modules/typescript/lib/lib.es5.d.ts:1349
concat(items)
concat(...
items):ModelRef<T>[]
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
• ...items: (ModelRef<T> | ConcatArray<ModelRef<T>>)[]
Additional arrays and/or items to add to the end of the array.
Returns
ModelRef<T>[]
Inherited from
Array.concat
Source
node_modules/typescript/lib/lib.es5.d.ts:1355
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
Inherited from
Array.copyWithin
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:62
entries()
entries():
IterableIterator<[number,ModelRef<T>]>
Returns an iterable of key, value pairs for every entry in the array
Returns
IterableIterator<[number, ModelRef<T>]>
Inherited from
Array.entries
Source
node_modules/typescript/lib/lib.es2015.iterable.d.ts:63
every()
every(predicate, thisArg)
every<
S>(predicate,thisArg?):this is S[]
Determines whether all the members of an array satisfy the specified test.
Type parameters
• S extends ModelRef<T>
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[]
Inherited from
Array.every
Source
node_modules/typescript/lib/lib.es5.d.ts:1432
every(predicate, thisArg)
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
Inherited from
Array.every
Source
node_modules/typescript/lib/lib.es5.d.ts:1441
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: ModelRef<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
Inherited from
Array.fill
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:51
filter()
filter(predicate, thisArg)
filter<
S>(predicate,thisArg?):S[]
Returns the elements of an array that meet the condition specified in a callback function.
Type parameters
• S extends ModelRef<T>
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[]
Inherited from
Array.filter
Source
node_modules/typescript/lib/lib.es5.d.ts:1468
filter(predicate, thisArg)
filter(
predicate,thisArg?):ModelRef<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
ModelRef<T>[]
Inherited from
Array.filter
Source
node_modules/typescript/lib/lib.es5.d.ts:1474
find()
find(predicate, thisArg)
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 extends ModelRef<T>
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
Inherited from
Array.find
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:29
find(predicate, thisArg)
find(
predicate,thisArg?):ModelRef<T>
Parameters
• predicate: (value, index, obj) => unknown
• thisArg?: any
Returns
ModelRef<T>
Inherited from
Array.find
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:30
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
Inherited from
Array.findIndex
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:41
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
• A
• D extends number = 1
Parameters
• this: A
• depth?: D
The maximum recursion depth
Returns
FlatArray<A, D>[]
Inherited from
Array.flat
Source
node_modules/typescript/lib/lib.es2019.array.d.ts:75
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
• U
• This = undefined
Parameters
• callback: (this, value, index, array) => 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
Source
node_modules/typescript/lib/lib.es2019.array.d.ts:64
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
Inherited from
Array.forEach
Source
node_modules/typescript/lib/lib.es5.d.ts:1456
includes()
includes(
searchElement,fromIndex?):boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
• searchElement: ModelRef<T>
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
Source
node_modules/typescript/lib/lib.es2016.array.include.d.ts:25
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: ModelRef<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
Inherited from
Array.indexOf
Source
node_modules/typescript/lib/lib.es5.d.ts:1417
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
Inherited from
Array.join
Source
node_modules/typescript/lib/lib.es5.d.ts:1360
keys()
keys():
IterableIterator<number>
Returns an iterable of keys in the array
Returns
IterableIterator<number>
Inherited from
Array.keys
Source
node_modules/typescript/lib/lib.es2015.iterable.d.ts:68
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: ModelRef<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
Inherited from
Array.lastIndexOf
Source
node_modules/typescript/lib/lib.es5.d.ts:1423
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
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[]
Inherited from
Array.map
Source
node_modules/typescript/lib/lib.es5.d.ts:1462
pop()
pop():
ModelRef<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
ModelRef<T>
Inherited from
Array.pop
Source
node_modules/typescript/lib/lib.es5.d.ts:1338
push()
push(...
items):number
Appends new elements to the end of an array, and returns the new length of the array.
Parameters
• ...items: ModelRef<T>[]
New elements to add to the array.
Returns
number
Inherited from
Array.push
Source
node_modules/typescript/lib/lib.es5.d.ts:1343
reduce()
reduce(callbackfn)
reduce(
callbackfn):ModelRef<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) => ModelRef<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
ModelRef<T>
Inherited from
Array.reduce
Source
node_modules/typescript/lib/lib.es5.d.ts:1480
reduce(callbackfn, initialValue)
reduce(
callbackfn,initialValue):ModelRef<T>
Parameters
• callbackfn: (previousValue, currentValue, currentIndex, array) => ModelRef<T>
• initialValue: ModelRef<T>
Returns
ModelRef<T>
Inherited from
Array.reduce
Source
node_modules/typescript/lib/lib.es5.d.ts:1481
reduce(callbackfn, initialValue)
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
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
Inherited from
Array.reduce
Source
node_modules/typescript/lib/lib.es5.d.ts:1487
reduceRight()
reduceRight(callbackfn)
reduceRight(
callbackfn):ModelRef<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) => ModelRef<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
ModelRef<T>
Inherited from
Array.reduceRight
Source
node_modules/typescript/lib/lib.es5.d.ts:1493
reduceRight(callbackfn, initialValue)
reduceRight(
callbackfn,initialValue):ModelRef<T>
Parameters
• callbackfn: (previousValue, currentValue, currentIndex, array) => ModelRef<T>
• initialValue: ModelRef<T>
Returns
ModelRef<T>
Inherited from
Array.reduceRight
Source
node_modules/typescript/lib/lib.es5.d.ts:1494
reduceRight(callbackfn, initialValue)
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
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
Inherited from
Array.reduceRight
Source
node_modules/typescript/lib/lib.es5.d.ts:1500
remove()
remove(
model):void
Parameters
• model: string | T | ModelRef<T>
Returns
void
Source
packages/core/src/models/relations.ts:151
reverse()
reverse():
ModelRef<T>[]
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
Returns
ModelRef<T>[]
Inherited from
Array.reverse
Source
node_modules/typescript/lib/lib.es5.d.ts:1365
shift()
shift():
ModelRef<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
ModelRef<T>
Inherited from
Array.shift
Source
node_modules/typescript/lib/lib.es5.d.ts:1370
slice()
slice(
start?,end?):ModelRef<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
ModelRef<T>[]
Inherited from
Array.slice
Source
node_modules/typescript/lib/lib.es5.d.ts:1380
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
Inherited from
Array.some
Source
node_modules/typescript/lib/lib.es5.d.ts:1450
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, ASCII character order.
[11,2,22,1].sort((a, b) => a - b)
Returns
this
Inherited from
Array.sort
Source
node_modules/typescript/lib/lib.es5.d.ts:1391
splice()
splice(start, deleteCount)
splice(
start,deleteCount?):ModelRef<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.
Returns
ModelRef<T>[]
An array containing the elements that were deleted.
Inherited from
Array.splice
Source
node_modules/typescript/lib/lib.es5.d.ts:1398
splice(start, deleteCount, items)
splice(
start,deleteCount, ...items):ModelRef<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.
• ...items: ModelRef<T>[]
Elements to insert into the array in place of the deleted elements.
Returns
ModelRef<T>[]
An array containing the elements that were deleted.
Inherited from
Array.splice
Source
node_modules/typescript/lib/lib.es5.d.ts:1406
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
Source
node_modules/typescript/lib/lib.es5.d.ts:1333
toString()
toString():
string
Returns a string representation of an array.
Returns
string
Inherited from
Array.toString
Source
node_modules/typescript/lib/lib.es5.d.ts:1329
unshift()
unshift(...
items):number
Inserts new elements at the start of an array, and returns the new length of the array.
Parameters
• ...items: ModelRef<T>[]
Elements to insert at the start of the array.
Returns
number
Inherited from
Array.unshift
Source
node_modules/typescript/lib/lib.es5.d.ts:1411
values()
values():
IterableIterator<ModelRef<T>>
Returns an iterable of values in the array
Returns
IterableIterator<ModelRef<T>>
Inherited from
Array.values
Source
node_modules/typescript/lib/lib.es2015.iterable.d.ts:73
from()
from(arrayLike)
staticfrom<T>(arrayLike):T[]
Creates an array from an array-like object.
Type parameters
• T
Parameters
• arrayLike: ArrayLike<T>
An array-like object to convert to an array.
Returns
T[]
Inherited from
Array.from
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:70
from(arrayLike, mapfn, thisArg)
staticfrom<T,U>(arrayLike,mapfn,thisArg?):U[]
Creates an array from an iterable object.
Type parameters
• T
• U
Parameters
• arrayLike: ArrayLike<T>
An array-like object to convert to an array.
• mapfn: (v, k) => 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
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:78
from(iterable)
staticfrom<T>(iterable):T[]
Creates an array from an iterable object.
Type parameters
• T
Parameters
• iterable: Iterable<T> | ArrayLike<T>
An iterable object to convert to an array.
Returns
T[]
Inherited from
Array.from
Source
node_modules/typescript/lib/lib.es2015.iterable.d.ts:81
from(iterable, mapfn, thisArg)
staticfrom<T,U>(iterable,mapfn,thisArg?):U[]
Creates an array from an iterable object.
Type parameters
• T
• U
Parameters
• iterable: Iterable<T> | ArrayLike<T>
An iterable object to convert to an array.
• mapfn: (v, k) => 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
Source
node_modules/typescript/lib/lib.es2015.iterable.d.ts:89
isArray()
staticisArray(arg):arg is any[]
Parameters
• arg: any
Returns
arg is any[]
Inherited from
Array.isArray
Source
node_modules/typescript/lib/lib.es5.d.ts:1512
of()
staticof<T>(...items):T[]
Returns a new array from a set of elements.
Type parameters
• T
Parameters
• ...items: T[]
A set of elements to include in the new array object.
Returns
T[]
Inherited from
Array.of
Source
node_modules/typescript/lib/lib.es2015.core.d.ts:84