Interface: RelationArray<T>

Defined in: src/entity/relation-array.ts:13

The value of a collection navigation property, such as customer.orders. It is a real array: adding an entity sets the entity's inverse navigation property (or foreign key) to point at the parent, attaching it to the parent's manager if it is detached, and removing one sets its inverse navigation property to null. Changes raise the array's arrayChanged event with an ArrayChangedArgs.

Extends

ObservableArray<T>

Type Parameters

T

T extends Entity = Entity

Indexable

[n: number]: T

Properties

[unscopables]

readonly [unscopables]: object

Defined in: node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

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 | undefined

[iterator]?

optional [iterator]?: boolean

[unscopables]?

readonly optional [unscopables]?: boolean

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

at?

optional at?: boolean

concat?

optional concat?: boolean

copyWithin?

optional copyWithin?: boolean

entries?

optional entries?: boolean

every?

optional every?: boolean

fill?

optional fill?: boolean

filter?

optional filter?: boolean

find?

optional find?: boolean

findIndex?

optional findIndex?: boolean

flat?

optional flat?: boolean

flatMap?

optional flatMap?: boolean

forEach?

optional forEach?: boolean

includes?

optional includes?: boolean

indexOf?

optional indexOf?: boolean

join?

optional join?: boolean

keys?

optional keys?: boolean

lastIndexOf?

optional lastIndexOf?: boolean

length?

optional length?: boolean

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

map?

optional map?: boolean

pop?

optional pop?: boolean

push?

optional push?: boolean

reduce?

optional reduce?: boolean

reduceRight?

optional reduceRight?: boolean

reverse?

optional reverse?: boolean

shift?

optional shift?: boolean

slice?

optional slice?: boolean

some?

optional some?: boolean

sort?

optional sort?: boolean

splice?

optional splice?: boolean

toLocaleString?

optional toLocaleString?: boolean

toString?

optional toString?: boolean

unshift?

optional unshift?: boolean

values?

optional values?: boolean

Inherited from

ObservableArray.[unscopables]

arrayChanged

arrayChanged: BreezeEvent<ArrayChangedArgs>

Defined in: src/entity/observable-array.ts:79

Inherited from

ObservableArray.arrayChanged

length

length: number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1326

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited from

ObservableArray.length

navigationProperty

navigationProperty: NavigationProperty

Defined in: src/entity/relation-array.ts:19

The NavigationProperty of parentEntity that holds this array.

parent?

optional parent?: Object

Defined in: src/entity/observable-array.ts:80

Inherited from

ObservableArray.parent

parentEntity

parentEntity: Entity

Defined in: src/entity/relation-array.ts:15

The entity whose navigation property holds this array.

parentProperty?

optional parentProperty?: DataProperty

Defined in: src/entity/relation-array.ts:17

Not set on a relation array: always undefined. Use navigationProperty.

Overrides

ObservableArray.parentProperty

Methods

[iterator]()

[iterator](): ArrayIterator<T>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

Returns

ArrayIterator<T>

Inherited from

ObservableArray.[iterator]

at()

at(index): T | undefined

Defined in: node_modules/typescript/lib/lib.es2022.array.d.ts:24

Returns the item located at the specified index.

Parameters

index

number

The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

T | undefined

Inherited from

ObservableArray.at

concat()

Call Signature

concat(...items): T[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1350

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[]

Inherited from

ObservableArray.concat

Call Signature

concat(...items): T[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1356

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[]

Inherited from

ObservableArray.concat

copyWithin()

copyWithin(target, start, end?): this

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:62

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

ObservableArray.copyWithin

entries()

entries(): ArrayIterator<[number, T]>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:83

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, T]>

Inherited from

ObservableArray.entries

every()

Call Signature

every<S>(predicate, thisArg?): this is S[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1433

Determines whether all the members of an array satisfy the specified test.

Type Parameters

S

S extends Entity

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

ObservableArray.every

Call Signature

every(predicate, thisArg?): boolean

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1442

Determines whether all the members of an array satisfy the specified test.

Parameters

predicate

(value, index, array) => unknown

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

ObservableArray.every

fill()

fill(value, start?, end?): this

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:51

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

Inherited from

ObservableArray.fill

filter()

Call Signature

filter<S>(predicate, thisArg?): S[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1469

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

S

S extends Entity

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

ObservableArray.filter

Call Signature

filter(predicate, thisArg?): T[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1475

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[]

Inherited from

ObservableArray.filter

find()

Call Signature

find<S>(predicate, thisArg?): S | undefined

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:29

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S extends Entity

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 | undefined

Inherited from

ObservableArray.find

Call Signature

find(predicate, thisArg?): T | undefined

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:30

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

T | undefined

Inherited from

ObservableArray.find

findIndex()

findIndex(predicate, thisArg?): number

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:41

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

ObservableArray.findIndex

flat()

flat<A, D>(this, depth?): FlatArray<A, D>[]

Defined in: node_modules/typescript/lib/lib.es2019.array.d.ts:75

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

A

A

D

D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

ObservableArray.flat

flatMap()

flatMap<U, This>(callback, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es2019.array.d.ts:64

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

U

This

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

ObservableArray.flatMap

forEach()

forEach(callbackfn, thisArg?): void

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1457

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

ObservableArray.forEach

includes()

includes(searchElement, fromIndex?): boolean

Defined in: node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

searchElement

T

The element to search for.

fromIndex?

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

ObservableArray.includes

indexOf()

indexOf(searchElement, fromIndex?): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1418

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

Inherited from

ObservableArray.indexOf

join()

join(separator?): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1361

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

ObservableArray.join

keys()

keys(): ArrayIterator<number>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:88

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

ObservableArray.keys

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1424

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

Inherited from

ObservableArray.lastIndexOf

load()

Call Signature

load(): Promise<QueryResult<QueriedAs<T>>>

Defined in: src/entity/relation-array.ts:20

Returns

Promise<QueryResult<QueriedAs<T>>>

Call Signature

load(querySuccessCallback?, queryErrorCallback?): Promise<QueryResult<QueriedAs<T>>>

Defined in: src/entity/relation-array.ts:22

Parameters

Deprecated

Await the returned promise instead of passing callbacks.

map()

map<U>(callbackfn, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1463

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[]

Inherited from

ObservableArray.map

pop()

pop(): T | undefined

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1339

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 | undefined

Inherited from

ObservableArray.pop

push()

push(...items): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1344

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

Inherited from

ObservableArray.push

reduce()

Call Signature

reduce(callbackfn): T

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1481

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

Inherited from

ObservableArray.reduce

Call Signature

reduce(callbackfn, initialValue): T

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1482

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => T

initialValue

T

Returns

T

Inherited from

ObservableArray.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1488

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

Inherited from

ObservableArray.reduce

reduceRight()

Call Signature

reduceRight(callbackfn): T

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1494

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

Inherited from

ObservableArray.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): T

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1495

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => T

initialValue

T

Returns

T

Inherited from

ObservableArray.reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1501

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

Inherited from

ObservableArray.reduceRight

reverse()

reverse(): T[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1366

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

T[]

Inherited from

ObservableArray.reverse

shift()

shift(): T | undefined

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1371

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 | undefined

Inherited from

ObservableArray.shift

slice()

slice(start?, end?): T[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1381

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[]

Inherited from

ObservableArray.slice

some()

some(predicate, thisArg?): boolean

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1451

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

ObservableArray.some

sort()

sort(compareFn?): this

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1392

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

Inherited from

ObservableArray.sort

splice()

Call Signature

splice(start, deleteCount?): T[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1399

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

T[]

An array containing the elements that were deleted.

Inherited from

ObservableArray.splice

Call Signature

splice(start, deleteCount, ...items): T[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1407

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

...T[]

Elements to insert into the array in place of the deleted elements.

Returns

T[]

An array containing the elements that were deleted.

Inherited from

ObservableArray.splice

toLocaleString()

Call Signature

toLocaleString(): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1334

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

ObservableArray.toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:64

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

ObservableArray.toLocaleString

toString()

toString(): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1330

Returns a string representation of an array.

Returns

string

Inherited from

ObservableArray.toString

unshift()

unshift(...items): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1412

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

Inherited from

ObservableArray.unshift

values()

values(): ArrayIterator<T>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:93

Returns an iterable of values in the array

Returns

ArrayIterator<T>

Inherited from

ObservableArray.values

promises

Interface: RelationArray<T> ​

Extends ​

Type Parameters ​

T ​

Indexable ​

Properties ​

[unscopables] ​

Index Signature ​

[iterator]? ​

[unscopables]? ​

at? ​

concat? ​

copyWithin? ​

entries? ​

every? ​

fill? ​

filter? ​

find? ​

findIndex? ​

flat? ​

flatMap? ​

forEach? ​

includes? ​

indexOf? ​

join? ​

keys? ​

lastIndexOf? ​

length? ​

map? ​

pop? ​

push? ​

reduce? ​

reduceRight? ​

reverse? ​

shift? ​

slice? ​

some? ​

sort? ​

splice? ​

toLocaleString? ​

toString? ​

unshift? ​

values? ​

Inherited from ​

arrayChanged ​

Inherited from ​

length ​

Inherited from ​

navigationProperty ​

parent? ​

Inherited from ​

parentEntity ​

parentProperty? ​

Overrides ​

Methods ​

[iterator]() ​

Returns ​

Inherited from ​

at() ​

Parameters ​

index ​

Returns ​

Inherited from ​

concat() ​

Call Signature ​

Parameters ​

items ​

Returns ​

Inherited from ​

Call Signature ​

Parameters ​

items ​

Returns ​

Inherited from ​

copyWithin() ​

Parameters ​

target ​

start ​

end? ​

Interface: RelationArray<T>

Extends

Type Parameters

T

Indexable

Properties

[unscopables]

Index Signature

[iterator]?

[unscopables]?

at?

concat?

copyWithin?

entries?

every?

fill?

filter?

find?

findIndex?

flat?

flatMap?

forEach?

includes?

indexOf?

join?

keys?

lastIndexOf?

length?

map?

pop?

push?

reduce?

reduceRight?

reverse?

shift?

slice?

some?

sort?

splice?

toLocaleString?

toString?

unshift?

values?

Inherited from

arrayChanged

Inherited from

length

Inherited from

navigationProperty

parent?

Inherited from

parentEntity

parentProperty?

Overrides

Methods

[iterator]()

Returns

Inherited from

at()

Parameters

index

Returns

Inherited from

concat()

Call Signature

Parameters

items

Returns

Inherited from

Call Signature

Parameters

items

Returns

Inherited from

copyWithin()

Parameters

target

start

end?

Returns