Type alias BaseConfiguration

BaseConfiguration: {
    deleteRealmIfMigrationNeeded?: boolean;
    disableFormatUpgrade?: boolean;
    encryptionKey?: ArrayBuffer | ArrayBufferView | Int8Array;
    fifoFilesFallbackPath?: string;
    inMemory?: boolean;
    onMigration?: MigrationCallback;
    path?: string;
    readOnly?: boolean;
    schema?: (RealmObjectConstructor<AnyRealmObject> | ObjectSchema)[];
    schemaVersion?: number;
    shouldCompact?: ((totalBytes, usedBytes) => boolean);
    sync?: SyncConfiguration;
}

Type declaration

  • Optional deleteRealmIfMigrationNeeded?: boolean
  • Optional disableFormatUpgrade?: boolean
  • Optional encryptionKey?: ArrayBuffer | ArrayBufferView | Int8Array
  • Optional fifoFilesFallbackPath?: string
  • Optional inMemory?: boolean
  • Optional onMigration?: MigrationCallback
  • Optional path?: string
  • Optional readOnly?: boolean
  • Optional schema?: (RealmObjectConstructor<AnyRealmObject> | ObjectSchema)[]
  • Optional schemaVersion?: number
  • Optional shouldCompact?: ((totalBytes, usedBytes) => boolean)
      • (totalBytes, usedBytes): boolean

      • Parameters

        • totalBytes: number
        • usedBytes: number

        Returns boolean

  • Optional sync?: SyncConfiguration

Settings

Theme

Generated using TypeDoc