Class OrderedCollection<T, EntryType>`Abstract`

An OrderedCollection is a homogenous sequence of values of any of the types that can be stored as properties of Realm objects. It can be accessed in any of the ways that a normal JavaScript Array can, including subscripting, enumerating with for-of and so on.

See

Array

Type Parameters

T = unknown
EntryType extends [unknown, unknown] = [number, T]

Hierarchy (view full)

export=.Collection<number, T, EntryType, T, CollectionChangeCallback<T, EntryType>>
- OrderedCollection

Implements

Omit<ReadonlyArray<T>, "entries">

Indexable

[n: number]: T

Index

Properties

`Readonly` [unscopables]

[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toString?: any;
    unshift?: any;
    values?: any;
} = ...

An Object whose truthy properties are properties that are excluded from the 'with' environment bindings of the associated objects.

Type declaration

Optional Readonly [unscopables]?: boolean
Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Optional length?: boolean
Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Accessors

length

get length(): number
Returns number
The number of values.
Implementation of Omit.length
- Defined in packages/realm/src/OrderedCollection.ts:278
set length(value): void
Parameters
- value: number
Returns void
Throws
An Error as the length property cannot be assigned.
Implementation of Omit.length
- Defined in packages/realm/src/OrderedCollection.ts:285

optional

get optional(): boolean
Whether null is a valid value for the collection.

Returns boolean
Whether null is a valid value for the collection.
- Defined in packages/realm/src/OrderedCollection.ts:302

type

get type(): string
Name of the type of items.

Returns string
The name of the type of values.
- Defined in packages/realm/src/OrderedCollection.ts:293

Methods

[iterator]

[iterator](): IterableIterator<T>
Returns IterableIterator<T>
An iterator that iterates over all the values in the collection.
Implementation of Omit.[iterator]
Overrides Collection.[iterator]
- Defined in packages/realm/src/OrderedCollection.ts:635

addListener

addListener(callback, keyPaths?): void
Add a listener callback which will be called when a live collection instance changes.
Parameters
- callback: CollectionChangeCallback<T, EntryType>
  A function to be called when changes occur.
- Optional keyPaths: string | string[]
  Indicates a lower bound on the changes relevant for the listener. This is a lower bound, since if multiple listeners are added (each with their own keyPaths) the union of these key-paths will determine the changes that are considered relevant for all listeners registered on the collection. In other words: A listener might fire more than the key-paths specify, if other listeners with different key-paths are present.
Returns void
Note
deletions and oldModificationsreport the indices in the collection before the change happened, whileinsertionsandnewModificationsreport the indices into the new version of the collection. @throws A {@link TypeAssertionError} ifcallback is not a function. @example wines.addListener((collection, changes) => { // collection === wines console.log(${changes.insertions.length} insertions); console.log(${changes.oldModifications.length} oldModifications); console.log(${changes.newModifications.length} newModifications); console.log(${changes.deletions.length} deletions); console.log(new size of collection: ${collection.length}); }); @example wines.addListener((collection, changes) => { console.log("A wine's brand might have changed"); }, ["brand"]); @note Adding the listener is an asynchronous operation, so the callback is invoked the first time to notify the caller when the listener has been added. Thus, when the callback is invoked the first time it will contain empty arrays for each property in the changes` object.
Inherited from Collection.addListener
- Defined in packages/realm/src/Collection.ts:136

at

at(index): undefined | T
Parameters
- index: number
Returns undefined | T
The element at the given index in the array; undefined if there is no element at the given index.

See
Array.prototype.at()

Params
index - The index of the element to return from the array. If the index is a negative number, the element at array.length + index is returned.
Implementation of Omit.at
- Defined in packages/realm/src/OrderedCollection.ts:626

avg

avg(property?): undefined | number
Computes the average of the values in the collection or of the given property among all the objects in the collection, or undefined if the collection is empty.

Only supported for int, float and double properties. null values are ignored entirely by this method and will not be factored into the average.
Parameters
- Optional property: string
  For a collection of objects, the property to take the average of.
Returns undefined | number
The sum.

Throws
An Error if no property with the name exists or if property is not numeric.
- Defined in packages/realm/src/OrderedCollection.ts:753

concat

concat(...items): T[]
Parameters
- Rest ...items: ConcatArray<T>[]
  Arrays and/or values to concatenate into a new array.
Returns T[]
A new array with the results of calling a provided function on every element in this array.

See
Array.prototype.concat()
Implementation of Omit.concat
- Defined in packages/realm/src/OrderedCollection.ts:327
concat(...items): T[]
Parameters
- Rest ...items: (T | ConcatArray<T>)[]
  Arrays and/or values to concatenate into a new array.
Returns T[]
A new array with the results of calling a provided function on every element in this array.

See
Array.prototype.concat()
Implementation of Omit.concat
- Defined in packages/realm/src/OrderedCollection.ts:333

description

description(): string
Returns string
A string describing the filters applied to this collection.
- Defined in packages/realm/src/OrderedCollection.ts:651

entries

entries(): Generator<EntryType, any, unknown>
Returns Generator<EntryType, any, unknown>
An iterator with all key/value pairs in the collection.

See
Array.prototype.entries()
Overrides Collection.entries
- Defined in packages/realm/src/OrderedCollection.ts:264

every

every<S>(predicate, thisArg?): this is readonly S[]
Type Parameters
- S
Parameters
- predicate: ((value, index, array) => value is S)
  - - (value, index, array): value is S
    - Parameters
      value: T
      index: number
      array: readonly T[]
      Returns value is S
- Optional thisArg: any
Returns this is readonly S[]
true if the callback function returns a truthy value for every collection element; otherwise, false.

See
Array.prototype.every()

Params
predicate - A function to test for each element.

Params
predicate.value - The current element being processed in the collection.

Params
predicate.index - The index of the current element being processed in the collection.

Params
predicate.array - The collection every was called upon.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.every
- Defined in packages/realm/src/OrderedCollection.ts:388
every(predicate, thisArg?): boolean
Parameters
- predicate: ((value, index, array) => unknown)
  - - (value, index, array): unknown
    - Parameters
      value: T
      index: number
      array: readonly T[]
      Returns unknown
- Optional thisArg: any
Returns boolean
true if the callback function returns a truthy value for every collection element; otherwise, false.

See
Array.prototype.every()

Params
predicate - A function to test for each element.

Params
predicate.value - The current element being processed in the collection.

Params
predicate.index - The index of the current element being processed in the collection.

Params
predicate.array - The collection every was called upon.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.every
- Defined in packages/realm/src/OrderedCollection.ts:401

filter

filter<S>(predicate, thisArg?): S[]
Type Parameters
- S
Parameters
- predicate: ((value, index, array) => value is S)
  - - (value, index, array): value is S
    - Parameters
      value: T
      index: number
      array: readonly T[]
      Returns value is S
- Optional thisArg: any
Returns S[]
A new array containing the elements of the collection for which the predicate function returned true.

See
Array.prototype.filter()

Params
predicate - A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the collection.

Params
predicate.value - The current element being processed in the collection.

Params
predicate.index - The index of the current element being processed in the collection.

Params
predicate.array - The collection filter was called upon.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.filter
- Defined in packages/realm/src/OrderedCollection.ts:449
filter(predicate, thisArg?): T[]
Parameters
- predicate: ((value, index, array) => unknown)
  - - (value, index, array): unknown
    - Parameters
      value: T
      index: number
      array: readonly T[]
      Returns unknown
- Optional thisArg: any
Returns T[]
A new array containing the elements of the collection for which the predicate function returned true.

See
Array.prototype.filter()

Params
predicate - A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the collection.

Params
predicate.value - The current element being processed in the collection.

Params
predicate.index - The index of the current element being processed in the collection.

Params
predicate.array - The collection filter was called upon.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.filter
- Defined in packages/realm/src/OrderedCollection.ts:459

filtered

filtered(queryString, ...args): export=.Results<T>
Returns new Results that represent this collection being filtered by the provided query.
Parameters
- queryString: string
  Query used to filter objects from the collection.
- Rest ...args: unknown[]
  Each subsequent argument is used by the placeholders (e.g. $0, $1, $2, …) in the query.
Returns export=.Results<T>
Results filtered according to the provided query.
Throws
An Error if the query or any other argument passed into this method is invalid.

Note
This is currently only supported for collections of Realm Objects.

Example
```
let merlots = wines.filtered('variety == "Merlot" && vintage <= $0', maxYear);
```
- Defined in packages/realm/src/OrderedCollection.ts:778

find

find<S>(predicate, thisArg?): undefined | S
Type Parameters
- S
Parameters
- predicate: ((this, value, index, obj) => value is S)
  - - (this, value, index, obj): value is S
    - Parameters
      this: void
      value: T
      index: number
      obj: T[]
      Returns value is S
- Optional thisArg: any
Returns undefined | S
The value of the first element in the array that satisfies the provided testing function. Otherwise, undefined is returned.

See
Array.prototype.find()

Params
predicate - A function that accepts up to three arguments. The find method calls the predicate function one time for each element in the collection.

Params
predicate.value - The value of the element.

Params
predicate.index - The index of the element.

Params
predicate.obj - The object being traversed.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.find
- Defined in packages/realm/src/OrderedCollection.ts:557
find<T>(predicate, thisArg?): undefined | T
Type Parameters
- T
Parameters
- predicate: ((value, index, obj) => unknown)
  - - (value, index, obj): unknown
    - Parameters
      value: T
      index: number
      obj: T[]
      Returns unknown
- Optional thisArg: any
Returns undefined | T
The value of the first element in the array that satisfies the provided testing function. Otherwise, undefined is returned.

See
Array.prototype.find()

Params
predicate - A function that accepts up to three arguments. The find method calls the predicate function one time for each element in the collection.

Params
predicate.value - The value of the element.

Params
predicate.index - The index of the element.

Params
predicate.obj - The object being traversed.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.find
- Defined in packages/realm/src/OrderedCollection.ts:570

findIndex

findIndex(predicate, thisArg?): number
Parameters
- predicate: ((value, index, obj) => unknown)
  - - (value, index, obj): unknown
    - Parameters
      value: T
      index: number
      obj: readonly T[]
      Returns unknown
- Optional thisArg: any
Returns number
The index of the first element in the array that satisfies the provided testing function. Otherwise, -1 is returned.

See
Array.prototype.findIndex()

Params
predicate - A function that accepts up to three arguments. The findIndex method calls the predicate function one time for each element in the collection.

Params
predicate.value - The value of the element.

Params
predicate.index - The index of the element.

Params
predicate.obj - The object being traversed.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.findIndex
- Defined in packages/realm/src/OrderedCollection.ts:583

flat

flat<A, D>(this, depth?): FlatArray<A, D>[]
Type Parameters
- A
- D extends number = 1
Parameters
- this: A
- Optional depth: D
Returns FlatArray<A, D>[]
A new array with the sub-array elements concatenated into it.

See
Array.prototype.flat()

Params
depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
Implementation of Omit.flat
- Defined in packages/realm/src/OrderedCollection.ts:617

flatMap

flatMap<U, This>(callback, thisArg?): U[]
Type Parameters
- U
- This = undefined
Parameters
- callback: ((this, value, index, array) => U | readonly U[])
  - - (this, value, index, array): U | readonly U[]
    - Parameters
      this: This
      value: T
      index: number
      array: T[]
      Returns U | readonly U[]
- Optional thisArg: This
Returns U[]
A new array with each element being the result of the callback function and flattened to a depth of 1.

See
Array.prototype.flatMap()

Params
callback - Function that produces an element of the new Array, taking three arguments:

Params
callback.currentValue - The current element being processed in the array.

Params
callback.index - The index of the current element being processed in the array.

Params
callback.array - The array flatMap was called upon.

Params
thisArg - Value to use as this when executing callback.
Implementation of Omit.flatMap
- Defined in packages/realm/src/OrderedCollection.ts:606

forEach

forEach(callbackfn, thisArg?): void
Parameters
- callbackfn: ((value, index, array) => void)
  - - (value, index, array): void
    - Parameters
      value: T
      index: number
      array: readonly T[]
      Returns void
- Optional thisArg: any
Returns void
See
Array.prototype.forEach()

Params
callbackfn - A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the collection.

Params
callbackfn.value - The current element being processed in the collection.

Params
callbackfn.index - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection forEach was called upon.

Params
thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.forEach
- Defined in packages/realm/src/OrderedCollection.ts:425

includes

includes(searchElement, fromIndex?): boolean
Parameters
- searchElement: T
- Optional fromIndex: number
Returns boolean
true if the searchElement is found in the array; otherwise, false.

See
Array.prototype.includes()

Params
searchElement - The element to search for.

Params
fromIndex - The position in this array at which to begin searching for searchElement. A negative value searches from the index of array.length + fromIndex by asc.

Note
fromIndex is currently not supported. So all searches start at index 0.
Implementation of Omit.includes
- Defined in packages/realm/src/OrderedCollection.ts:594

indexOf

indexOf(searchElement, fromIndex?): number
Parameters
- searchElement: T
- Optional fromIndex: number
Returns number
The first index at which a given element can be found in the collection, or -1 if it is not present.

See
Array.prototype.indexOf()

Params
searchElement - Element to locate in the collection.

Params
fromIndex - The collection index at which to begin the search. If omitted, the search starts at index 0.

Note
fromIndex is currently not supported. So all searches start at index 0.
Implementation of Omit.indexOf
- Defined in packages/realm/src/OrderedCollection.ts:361

isEmpty

isEmpty(): boolean
Checks if this collection is empty.

Returns boolean
true if the collection is empty, false if not.
- Defined in packages/realm/src/OrderedCollection.ts:659

`Abstract` isValid

isValid(): boolean
Checks if this collection has not been deleted and is part of a valid Realm.

Returns boolean
true if the collection can be safely accessed.

Since
0.14.0
Inherited from Collection.isValid
- Defined in packages/realm/src/Collection.ts:105

join

join(separator?): string
Parameters
- Optional separator: string
Returns string
A string representing the elements of the collection.

See
Array.prototype.join()

Params
separator - A string used to separate one element of the collection from the next in the resulting String.
Implementation of Omit.join
- Defined in packages/realm/src/OrderedCollection.ts:342

keys

keys(): Generator<number, any, unknown>
Returns Generator<number, any, unknown>
An iterator with all keys in the collection.

See
Array.prototype.keys()
Implementation of Omit.keys
Overrides Collection.keys
- Defined in packages/realm/src/OrderedCollection.ts:241

lastIndexOf

lastIndexOf(searchElement, fromIndex?): number
Parameters
- searchElement: T
- Optional fromIndex: number
Returns number
The last index at which a given element can be found in the collection, or -1 if it is not present. The collection is searched backwards, starting at fromIndex.

See
Array.prototype.lastIndexOf()

Params
searchElement - Element to locate in the collection.

Params
fromIndex - The collection index at which to begin the search. If omitted, the search starts at the last index.
Implementation of Omit.lastIndexOf
- Defined in packages/realm/src/OrderedCollection.ts:376

map

map<U>(callbackfn, thisArg?): U[]
Type Parameters
- U
Parameters
- callbackfn: ((value, index, array) => U)
  - - (value, index, array): U
    - Parameters
      value: T
      index: number
      array: readonly T[]
      Returns U
- Optional thisArg: any
Returns U[]
A new array containing the results of calling the callbackfn function on each element in the collection.

See
Array.prototype.map()

Params
callbackfn - A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the collection.

Params
callbackfn.value - The current element being processed in the collection.

Params
callbackfn.index - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection map was called upon.

Params
thisArg - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.map
- Defined in packages/realm/src/OrderedCollection.ts:437

max

max(property?): undefined | number | Date
Returns the maximum value of the values in the collection or of the given property among all the objects in the collection, or undefined if the collection is empty.

Only supported for int, float, double and date properties. null values are ignored entirely by this method and will not be returned.
Parameters
- Optional property: string
  For a collection of objects, the property to take the maximum of.
Returns undefined | number | Date
The maximum value.

Throws
An Error if no property with the name exists or if property is not numeric/date.
- Defined in packages/realm/src/OrderedCollection.ts:701

min

min(property?): undefined | number | Date
Returns the minimum value of the values in the collection or of the given property among all the objects in the collection, or undefined if the collection is empty.

Only supported for int, float, double and date properties. null values are ignored entirely by this method and will not be returned.
Parameters
- Optional property: string
  For a collection of objects, the property to take the minimum of.
Returns undefined | number | Date
The minimum value.

Throws
A TypeAssertionError if no property with the name exists or if property is not numeric/date.
- Defined in packages/realm/src/OrderedCollection.ts:674

reduce

reduce(callbackfn): T
Parameters
- callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
  - - (previousValue, currentValue, currentIndex, array): T
    - Parameters
      previousValue: T
      currentValue: T
      currentIndex: number
      array: readonly T[]
      Returns T
Returns T
The value that results from the reduction.

See
Array.prototype.reduce()

Params
callbackfn - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the collection.

Params
callbackfn.previousValue - The value previously returned in the last invocation of the callbackfn function, or initialValue, if supplied. (See below.)

Params
callbackfn.currentValue - The current element being processed in the collection.

Params
callbackfn.currentIndex - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection reduce was called upon.

Params
initialValue - 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 element value.
Implementation of Omit.reduce
- Defined in packages/realm/src/OrderedCollection.ts:473
reduce(callbackfn, initialValue): T
Parameters
- callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
  - - (previousValue, currentValue, currentIndex, array): T
    - Parameters
      previousValue: T
      currentValue: T
      currentIndex: number
      array: readonly T[]
      Returns T
- initialValue: T
Returns T
The value that results from the reduction.

See
Array.prototype.reduce()

Params
callbackfn - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the collection.

Params
callbackfn.previousValue - The value previously returned in the last invocation of the callbackfn function, or initialValue, if supplied. (See below.)

Params
callbackfn.currentValue - The current element being processed in the collection.

Params
callbackfn.currentIndex - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection reduce was called upon.

Params
initialValue - 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 element value.
Implementation of Omit.reduce
- Defined in packages/realm/src/OrderedCollection.ts:484
reduce<U>(callbackfn, initialValue): U
Type Parameters
- U
Parameters
- callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
  - - (previousValue, currentValue, currentIndex, array): U
    - Parameters
      previousValue: U
      currentValue: T
      currentIndex: number
      array: readonly T[]
      Returns U
- initialValue: U
Returns U
The value that results from the reduction.

See
Array.prototype.reduce()

Params
callbackfn - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the collection.

Params
callbackfn.previousValue - The value previously returned in the last invocation of the callbackfn function, or initialValue, if supplied. (See below.)

Params
callbackfn.currentValue - The current element being processed in the collection.

Params
callbackfn.currentIndex - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection reduce was called upon.

Params
initialValue - 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 element value.
Implementation of Omit.reduce
- Defined in packages/realm/src/OrderedCollection.ts:498

reduceRight

reduceRight(callbackfn): T
Parameters
- callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
  - - (previousValue, currentValue, currentIndex, array): T
    - Parameters
      previousValue: T
      currentValue: T
      currentIndex: number
      array: readonly T[]
      Returns T
Returns T
The value that results from the reduction.

See
Array.prototype.reduceRight()

Params
callbackfn - A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the collection.

Params
callbackfn.previousValue - The value previously returned in the last invocation of the callbackfn function, or initialValue, if supplied. (See below.)

Params
callbackfn.currentValue - The current element being processed in the collection.

Params
callbackfn.currentIndex - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection reduceRight was called upon.

Params
initialValue - 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 element value.
Implementation of Omit.reduceRight
- Defined in packages/realm/src/OrderedCollection.ts:515
reduceRight(callbackfn, initialValue): T
Parameters
- callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
  - - (previousValue, currentValue, currentIndex, array): T
    - Parameters
      previousValue: T
      currentValue: T
      currentIndex: number
      array: readonly T[]
      Returns T
- initialValue: T
Returns T
The value that results from the reduction.

See
Array.prototype.reduceRight()

Params
callbackfn - A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the collection.

Params
callbackfn.previousValue - The value previously returned in the last invocation of the callbackfn function, or initialValue, if supplied. (See below.)

Params
callbackfn.currentValue - The current element being processed in the collection.

Params
callbackfn.currentIndex - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection reduceRight was called upon.

Params
initialValue - 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 element value.
Implementation of Omit.reduceRight
- Defined in packages/realm/src/OrderedCollection.ts:526
reduceRight<U>(callbackfn, initialValue): U
Type Parameters
- U
Parameters
- callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
  - - (previousValue, currentValue, currentIndex, array): U
    - Parameters
      previousValue: U
      currentValue: T
      currentIndex: number
      array: readonly T[]
      Returns U
- initialValue: U
Returns U
The value that results from the reduction.

See
Array.prototype.reduceRight()

Params
callbackfn - A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the collection.

Params
callbackfn.previousValue - The value previously returned in the last invocation of the callbackfn function, or initialValue, if supplied. (See below.)

Params
callbackfn.currentValue - The current element being processed in the collection.

Params
callbackfn.currentIndex - The index of the current element being processed in the collection.

Params
callbackfn.array - The collection reduceRight was called upon.

Params
initialValue - 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 element value.
Implementation of Omit.reduceRight
- Defined in packages/realm/src/OrderedCollection.ts:540

removeAllListeners

removeAllListeners(): void
Remove all callback listeners from the collection instance.

Returns void
Inherited from Collection.removeAllListeners
- Defined in packages/realm/src/Collection.ts:155

removeListener

removeListener(callback): void
Remove the listener callback from the collection instance.
Parameters
- callback: CollectionChangeCallback<T, EntryType>
  Callback function that was previously added as a listener through the Collection.addListener method.
Returns void
Throws
a TypeAssertionError If callback is not a function.
Inherited from Collection.removeListener
- Defined in packages/realm/src/Collection.ts:147

slice

slice(start?, end?): T[]
Parameters
- Optional start: number
- Optional end: number
Returns T[]
A new array containing the elements between the start and end indices.

See
Array.prototype.slice()

Params
start - Zero-based index at which to begin extraction.

Params
end - Zero-based index at which to end extraction. It extracts up to but not including end.
Implementation of Omit.slice
- Defined in packages/realm/src/OrderedCollection.ts:351

snapshot

snapshot(): export=.Results<T>
Create a frozen snapshot of the collection.

Values added to and removed from the original collection will not be reflected in the Results returned by this method, including if the values of properties are changed to make them match or not match any filters applied.

This is not a deep snapshot. Realm objects contained in this snapshot will continue to update as changes are made to them, and if they are deleted from the Realm they will be replaced by null at the respective indices.

Returns export=.Results<T>
Results which will not live update.
- Defined in packages/realm/src/OrderedCollection.ts:890

some

some(predicate, thisArg?): boolean
Parameters
- predicate: ((value, index, array) => unknown)
  - - (value, index, array): unknown
    - Parameters
      value: T
      index: number
      array: readonly T[]
      Returns unknown
- Optional thisArg: any
Returns boolean
true if the callback function returns a truthy value for any collection element; otherwise, false.

See
Array.prototype.some()

Params
predicate - A function to test for each element.

Params
predicate.value - The current element being processed in the collection.

Params
predicate.index - The index of the current element being processed in the collection.

Params
predicate.array - The collection every was called upon.

Params
thisArg - An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Implementation of Omit.some
- Defined in packages/realm/src/OrderedCollection.ts:414

sorted

sorted(reverse?): export=.Results<T>
Returns new Results that represent a sorted view of this collection.

A collection of Realm Objects can be sorted on one or more properties of those objects, or of properties of objects linked to by those objects. To sort by a single property, simply pass the name of that property to sorted(), optionally followed by a boolean indicating if the sort should be reversed. For more than one property, you must pass an array of sort descriptors which list which properties to sort on.

Collections of other types sort on the values themselves rather than properties of the values, and so no property name or sort descriptors should be supplied.
Parameters
- Optional reverse: boolean
  Sort in descending order rather than ascended. It may not be applied if descriptor is an array of sort descriptors.
Returns export=.Results<T>
Results sorted according to the arguments passed in.

Throws
An Error if a specified property does not exist.
- Defined in packages/realm/src/OrderedCollection.ts:808
sorted(descriptor): export=.Results<T>
Returns new Results that represent a sorted view of this collection.

A collection of Realm Objects can be sorted on one or more properties of those objects, or of properties of objects linked to by those objects. To sort by a single property, simply pass the name of that property to sorted(), optionally followed by a boolean indicating if the sort should be reversed. For more than one property, you must pass an array of sort descriptors which list which properties to sort on.

Collections of other types sort on the values themselves rather than properties of the values, and so no property name or sort descriptors should be supplied.
Parameters
- descriptor: export=.SortDescriptor[]
  The property name(s) to sort the collection on.
Returns export=.Results<T>
Results sorted according to the arguments passed in.

Throws
An Error if a specified property does not exist.
- Defined in packages/realm/src/OrderedCollection.ts:827
sorted(descriptor, reverse?): export=.Results<T>
Returns new Results that represent a sorted view of this collection.

A collection of Realm Objects can be sorted on one or more properties of those objects, or of properties of objects linked to by those objects. To sort by a single property, simply pass the name of that property to sorted(), optionally followed by a boolean indicating if the sort should be reversed. For more than one property, you must pass an array of sort descriptors which list which properties to sort on.

Collections of other types sort on the values themselves rather than properties of the values, and so no property name or sort descriptors should be supplied.
Parameters
- descriptor: string
  The property name(s) to sort the collection on.
- Optional reverse: boolean
Returns export=.Results<T>
Results sorted according to the arguments passed in.

Throws
An Error if a specified property does not exist.
- Defined in packages/realm/src/OrderedCollection.ts:846

sum

sum(property?): number
Computes the sum of the values in the collection or of the given property among all the objects in the collection, or 0 if the collection is empty.

Only supported for int, float and double properties. null values are ignored entirely by this method.
Parameters
- Optional property: string
  For a collection of objects, the property to take the sum of.
Returns number
The sum.

Throws
An Error if no property with the name exists or if property is not numeric.
- Defined in packages/realm/src/OrderedCollection.ts:728

toJSON

toJSON(): DefaultObject[]
The plain object representation for JSON serialization. Use circular JSON serialization libraries such as @ungap/structured-clone and flatted to stringify Realm entities that have circular structures.

Returns DefaultObject[]
An array of plain objects.
- Defined in packages/realm/src/OrderedCollection.ts:225

toLocaleString

toLocaleString(): string
Returns string
A localized string representation of the collection.

See
Array.prototype.toLocaleString()
Implementation of Omit.toLocaleString
- Defined in packages/realm/src/OrderedCollection.ts:319

toString

toString(): string
Returns string
A string representation of the collection.

See
Array.prototype.toString()
Implementation of Omit.toString
- Defined in packages/realm/src/OrderedCollection.ts:312

values

values(): Generator<T, any, unknown>
Returns Generator<T, any, unknown>
An iterator with all values in the collection.

See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values | Array.prototype.values()}
Implementation of Omit.values
Overrides Collection.values
- Defined in packages/realm/src/OrderedCollection.ts:252

Class OrderedCollection<T, EntryType>Abstract

See

Type Parameters

T = unknown

EntryType extends [unknown, unknown] = [number, T]

Hierarchy (view full)

Implements

Indexable

Index

Properties

Accessors

Methods

Properties

Readonly [unscopables]

Type declaration

Optional Readonly [unscopables]?: boolean

Optional length?: boolean

Accessors

length

Returns number

Parameters

value: number

Returns void

Throws

optional

Returns boolean

type

Returns string

Methods

[iterator]

Returns IterableIterator<T>

addListener

Parameters

callback: CollectionChangeCallback<T, EntryType>

Optional keyPaths: string | string[]

Returns void

Note

at

Parameters

index: number

Returns undefined | T

See

Params

avg

Parameters

Optional property: string

Returns undefined | number

Throws

concat

Parameters

Rest ...items: ConcatArray<T>[]

Returns T[]

See

Parameters

Rest ...items: (T | ConcatArray<T>)[]

Returns T[]

See

description

Returns string

entries

Returns Generator<EntryType, any, unknown>

See

every

Type Parameters

S

Parameters

predicate: ((value, index, array) => value is S)

Parameters

value: T

index: number

array: readonly T[]

Returns value is S

Optional thisArg: any

Returns this is readonly S[]

See

Params

Params

Params

Params

Params

Class OrderedCollection<T, EntryType>`Abstract`

`Readonly` [unscopables]

`Optional` `Readonly` [unscopables]?: boolean

`Optional` length?: boolean

`Optional` keyPaths: string | string[]

`Optional` property: string

`Rest` ...items: ConcatArray<T>[]

`Rest` ...items: (T | ConcatArray<T>)[]

`Optional` thisArg: any

`Optional` thisArg: any

`Optional` thisArg: any

`Optional` thisArg: any

`Rest` ...args: unknown[]

`Optional` thisArg: any