Class Set

Hierarchy (view full)

Collection
- Set

Properties

`Readonly` isFrozen

isFrozen: boolean

Deprecated

Add is_frozen to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` isValid

isValid: boolean

`Readonly` objectSchema

objectSchema: Readonly<ObjectSchema>

`Readonly` parentColumnKey

parentColumnKey: ColKey

Deprecated

Add get_parent_column_key to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` parentObjectKey

parentObjectKey: ObjKey

Deprecated

Add get_parent_object_key to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` parentTableKey

parentTableKey: TableKey

Deprecated

Add get_parent_table_key to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` realm

realm: Realm

Deprecated

Add get_realm to your opt-in list (under classes/Collection/methods/) to use this.

`Readonly` size

size: number

`Readonly` type

type: PropertyType

Deprecated

Add get_type to your opt-in list (under classes/Collection/methods/) to use this.

Methods

addNotificationCallback

addNotificationCallback(cb, keyPaths): NotificationToken
Parameters
- cb: ((changes) => void)
  - - (changes): void
    - Parameters
      changes: Readonly<CollectionChangeSet>
      Returns void
- keyPaths: undefined | [TableKey, ColKey][][]
Returns NotificationToken
Deprecated
Add add_notification_callback to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.addNotificationCallback
- Defined in packages/realm/binding/generated/native.d.ts:982

asResults

asResults(): Results
Returns Results
Inherited from Collection.asResults
- Defined in packages/realm/binding/generated/native.d.ts:974

average

average(): undefined | Mixed
Returns undefined | Mixed
Deprecated
Add average to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1060

averageOf

averageOf(column): undefined | Mixed
Parameters
- column: ColKey
Returns undefined | Mixed
Deprecated
Add average_of to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1062

deleteAll

deleteAll(): void
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1048

filter

filter(q): Results
Parameters
- q: Query
Returns Results
Deprecated
Add filter to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1050

findAny

findAny(value): number
Parameters
- value: MixedArg
Returns number
Deprecated
Add find_any to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.findAny
- Defined in packages/realm/binding/generated/native.d.ts:969

get

get(ndx): Obj
Parameters
- ndx: number
Returns Obj
Deprecated
Add get to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1044

getAny

getAny(ndx): Mixed
Parameters
- ndx: number
Returns Mixed
Inherited from Collection.getAny
- Defined in packages/realm/binding/generated/native.d.ts:967

insertAny

insertAny(val): [number, boolean]
Parameters
- val: MixedArg
Returns [number, boolean]
- Defined in packages/realm/binding/generated/native.d.ts:1045

max

max(): undefined | Mixed
Returns undefined | Mixed
Deprecated
Add max to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1052

maxOf

maxOf(column): undefined | Mixed
Parameters
- column: ColKey
Returns undefined | Mixed
Deprecated
Add max_of to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1054

min

min(): undefined | Mixed
Returns undefined | Mixed
Deprecated
Add min to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1056

minOf

minOf(column): undefined | Mixed
Parameters
- column: ColKey
Returns undefined | Mixed
Deprecated
Add min_of to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1058

removeAll

removeAll(): void
Returns void
- Defined in packages/realm/binding/generated/native.d.ts:1047

removeAny

removeAny(val): [number, boolean]
Parameters
- val: MixedArg
Returns [number, boolean]
- Defined in packages/realm/binding/generated/native.d.ts:1046

snapshot

snapshot(): Results
Returns Results
Deprecated
Add snapshot to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.snapshot
- Defined in packages/realm/binding/generated/native.d.ts:976

sort

sort(order): Results
Parameters
- order: SortDescriptor
Returns Results
Deprecated
Add sort to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.sort
- Defined in packages/realm/binding/generated/native.d.ts:978

sortByName

sortByName(keyPaths): Results
Parameters
- keyPaths: readonly [string, boolean][]
Returns Results
Deprecated
Add sort_by_name to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.sortByName
- Defined in packages/realm/binding/generated/native.d.ts:980

sum

sum(): Mixed
Returns Mixed
Deprecated
Add sum to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1064

sumOf

sumOf(column): Mixed
Parameters
- column: ColKey
Returns Mixed
Deprecated
Add sum_of to your opt-in list (under classes/Set/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1066

verifyAttached

verifyAttached(): void
Returns void
Deprecated
Add verify_attached to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.verifyAttached
- Defined in packages/realm/binding/generated/native.d.ts:971

verifyInTransaction

verifyInTransaction(): void
Returns void
Deprecated
Add verify_in_transaction to your opt-in list (under classes/Collection/methods/) to use this.
Inherited from Collection.verifyInTransaction
- Defined in packages/realm/binding/generated/native.d.ts:973

`Static` make

make(r, parent, col): Set
Parameters
- r: Realm
- parent: Readonly<Obj>
- col: ColKey
Returns Set
- Defined in packages/realm/binding/generated/native.d.ts:1067

Class Set

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonly isFrozen

Deprecated

Readonly isValid

Readonly objectSchema

Readonly parentColumnKey

Deprecated

Readonly parentObjectKey

Deprecated

Readonly parentTableKey

Deprecated

Readonly realm

Deprecated

Readonly size

Readonly type

Deprecated

Methods

addNotificationCallback

Parameters

cb: ((changes) => void)

Parameters

changes: Readonly<CollectionChangeSet>

Returns void

keyPaths: undefined | [TableKey, ColKey][][]

Returns NotificationToken

Deprecated

asResults

Returns Results

average

Returns undefined | Mixed

Deprecated

averageOf

Parameters

column: ColKey

Returns undefined | Mixed

Deprecated

deleteAll

Returns void

filter

Parameters

q: Query

Returns Results

Deprecated

findAny

Parameters

value: MixedArg

Returns number

Deprecated

get

Parameters

ndx: number

Returns Obj

Deprecated

getAny

Parameters

ndx: number

Returns Mixed

insertAny

Parameters

val: MixedArg

Returns [number, boolean]

max

Returns undefined | Mixed

Deprecated

maxOf

Parameters

column: ColKey

Returns undefined | Mixed

Deprecated

min

Returns undefined | Mixed

Deprecated

minOf

Parameters

column: ColKey

`Readonly` isFrozen

`Readonly` isValid

`Readonly` objectSchema

`Readonly` parentColumnKey

`Readonly` parentObjectKey

`Readonly` parentTableKey

`Readonly` realm

`Readonly` size

`Readonly` type

`Static` make