Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRealmProviderProps

Props passed to a RealmProvider component.

Extends the Realm.Configuration matching the Realm JS version installed as peer dependency.

Hierarchy

  • Configuration
    • IRealmProviderProps

Index

Properties

children

children: React.ReactNode | RealmRenderer

Optional deleteRealmIfMigrationNeeded

deleteRealmIfMigrationNeeded: boolean

Optional disableFormatUpgrade

disableFormatUpgrade: boolean

Optional encryptionKey

encryptionKey: ArrayBuffer | ArrayBufferView | Int8Array

Optional inMemory

inMemory: boolean

Optional migration

migration: function

Type declaration

    • (oldRealm: Realm, newRealm: Realm): void
    • Parameters

      • oldRealm: Realm
      • newRealm: Realm

      Returns void

Optional path

path: string

Optional readOnly

readOnly: boolean

Optional schema

schema: (ObjectClass | ObjectSchema)[]

Optional schemaVersion

schemaVersion: number

Optional shouldCompactOnLaunch

shouldCompactOnLaunch: function

Type declaration

    • (totalBytes: number, usedBytes: number): boolean
    • Parameters

      • totalBytes: number
      • usedBytes: number

      Returns boolean

Optional sync

sync: Partial<SyncConfiguration>

Optional updateOnChange

updateOnChange: boolean