Class Dictionary

Hierarchy (view full)

Collection
- Dictionary

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` keys

keys: Results

`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.

`Readonly` values

values: Results

Methods

[iterator]

[iterator](): Iterator<[Readonly<Mixed>, Mixed], any, undefined>
Returns Iterator<[Readonly<Mixed>, Mixed], any, undefined>
- Defined in packages/realm/binding/generated/native.d.ts:1091

addKeyBasedNotificationCallback

addKeyBasedNotificationCallback(cb, keyPaths): NotificationToken
Parameters
- cb: ((changes) => void)
  - - (changes): void
    - Parameters
      changes: DictionaryChangeSet
      Returns void
- keyPaths: undefined | [TableKey, ColKey][][]
Returns NotificationToken
- Defined in packages/realm/binding/generated/native.d.ts:1079

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

contains

contains(key): boolean
Parameters
- key: string
Returns boolean
- Defined in packages/realm/binding/generated/native.d.ts:1076

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

freeze

freeze(frozen_realm): Dictionary
Parameters
- frozen_realm: Readonly<Realm>
Returns Dictionary
Deprecated
Add freeze to your opt-in list (under classes/Dictionary/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1078

get

get(key): Obj
Parameters
- key: string
Returns Obj
Deprecated
Add get to your opt-in list (under classes/Dictionary/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1073

getAny

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

getPair

getPair(ndx): [string, Mixed]
Parameters
- ndx: number
Returns [string, Mixed]
Deprecated
Add get_pair to your opt-in list (under classes/Dictionary/methods/) to use this.
- Defined in packages/realm/binding/generated/native.d.ts:1075

insertAny

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

insertEmbedded

insertEmbedded(key): Obj
Parameters
- key: string
Returns Obj
- Defined in packages/realm/binding/generated/native.d.ts:1084

removeAll

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

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

tryErase

tryErase(key): boolean
Parameters
- key: string
Returns boolean
- Defined in packages/realm/binding/generated/native.d.ts:1087

tryGetAny

tryGetAny(key): undefined | Mixed
Parameters
- key: string
Returns undefined | Mixed
- Defined in packages/realm/binding/generated/native.d.ts:1085

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): Dictionary
Parameters
- r: Realm
- parent: Readonly<Obj>
- col: ColKey
Returns Dictionary
- Defined in packages/realm/binding/generated/native.d.ts:1088

Class Dictionary

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonly isFrozen

Deprecated

Readonly isValid

Readonly keys

Readonly objectSchema

Readonly parentColumnKey

Deprecated

Readonly parentObjectKey

Deprecated

Readonly parentTableKey

Deprecated

Readonly realm

Deprecated

Readonly size

Readonly type

Deprecated

Readonly values

Methods

[iterator]

Returns Iterator<[Readonly<Mixed>, Mixed], any, undefined>

addKeyBasedNotificationCallback

Parameters

cb: ((changes) => void)

Parameters

changes: DictionaryChangeSet

Returns void

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

Returns NotificationToken

addNotificationCallback

Parameters

cb: ((changes) => void)

Parameters

changes: Readonly<CollectionChangeSet>

Returns void

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

Returns NotificationToken

Deprecated

asResults

Returns Results

contains

Parameters

key: string

Returns boolean

findAny

Parameters

value: MixedArg

Returns number

Deprecated

freeze

Parameters

frozen_realm: Readonly<Realm>

Returns Dictionary

Deprecated

get

Parameters

key: string

Returns Obj

Deprecated

getAny

Parameters

ndx: number

Returns Mixed

getPair

Parameters

ndx: number

Returns [string, Mixed]

Deprecated

insertAny

Parameters

key: string

value: MixedArg

Returns [number, boolean]

insertEmbedded

Parameters

`Readonly` isFrozen

`Readonly` isValid

`Readonly` keys

`Readonly` objectSchema

`Readonly` parentColumnKey

`Readonly` parentObjectKey

`Readonly` parentTableKey

`Readonly` realm

`Readonly` size

`Readonly` type

`Readonly` values

`Static` make