Digite alias BaseConfiguration

Configuração da base: {
    deleteRealm IfMigrationNeeded?: booleano;
    disableFormatUpgrade?: booleano;
    encryptionKey?: ArrayBuffer | ArrayBufferView | Int8Array;
    fifoFilesFallbackPath?: string;
    inMemory?: booleano;
    migrationOptions?: MigrationOptions;
    onFirstOpen?: ((Realm) => vazio);
    onMigration?: MigrationCallback;
    caminho?: string;
    Somente leitura?: booleano;
    schema?: (ObjectClass<AnyRealmObject> | Esquema de objetos)[];
    Versão do esquema?: número;
    shouldCompact?: ((totalBytes , usedBytes ) => boolean ) ;
    sincronizar ?: SyncConfiguration ;
}

As opções usadas para criar uma Instância de Realm.

Declaração de tipo

  • Optional exclua oRealmsea migração fornecessária?: booleano

    Especifica se este Realm deve ser excluído se uma migração for necessária. A opção é incompatível com a opção sync. @default: false

    desde

    1.13.0

  • Optional desabilitar a atualização do formato?: booleano

    Especifica se o formato de arquivo desse Realm deve ser atualizado automaticamente se tiver sido criado com uma versão mais antiga da biblioteca do Realm. Se definido como true e uma atualização do formato de arquivo for necessária, será gerado um erro.

    default

    false
    

    desde

    2.1.0

  • Optional chave de criptografia?: ArrayBuffer | ArrayBufferView | Int8Array

    A chave de criptografia de 512 bits (64 bytes) usada para criptografar e descriptografar todos os dados no Realm.

    desde

    0.11.1

  • Optional caminho de contingência dos arquivos fifo?: string

    A abertura de um Realm cria uma série de arquivos especiais FIFO para coordenar o acesso ao Realm entre threads e processos. Se o arquivo Realm estiver armazenado em um local que não permite a criação de arquivos especiais FIFO (por exemplo sistemas de arquivos FAT32), o Realm não poderá ser aberto. Nesse caso, o Realm precisa de um local diferente para armazenar esses arquivos e esta propriedade define esse local. Os arquivos especiais FIFO são muito leves e o arquivo Realm principal ainda será armazenado no local definido pela propriedade path . Esta propriedade será ignorada se o diretório definido por path permitir arquivos especiais FIFO.

    desde

    2.23.0

  • Optional inMemory?: booleano

    Especifica se este Realm deve ser aberto na memória. Isso ainda exige um caminho (pode ser o caminho padrão) para identificar o Realm, para que outros processos possam abrir o mesmo Realm. O arquivo também será usado como espaço de troca se o Realm ficar maior do que o que cabe na memória, mas não for persistente e será removido quando a última instância for fechada. Esta opção é incompatível com a opção sync.

    default

    false
    

    desde

    0.10.0

  • Optional opções de migração?: MigrationOptions
  • Optional naprimeiraabertura?: ((Realm) => vazio)

    A função chamada ao abrir um Realm pela primeira vez. A função pode preencher o Realm antes de abri-lo. Ao chamar o retorno de chamada, o Realm estará em uma transação de escrita.

    Param: Realm

    O Realm recém-criado.

    desde

    10.14.0

      • (Realm): vazio
      • A função chamada ao abrir um Realm pela primeira vez. A função pode preencher o Realm antes de abri-lo. Ao chamar o retorno de chamada, o Realm estará em uma transação de escrita.

        Parâmetros

        • domínio : Realm

          O Realm recém-criado.

        Retorna nulo

        desde

        10.14.0

  • Optional namigração?: MigrationCallback

    A função a ser executada se uma migração for necessária.

    Essa função deve fornecer toda a lógica para converter modelos de dados de esquemas anteriores para o novo esquema. Esta opção é incompatível com a opção sync .

    A função usa dois argumentos:

    • oldRealm - O Realm antes da migração ser realizada.
    • newRealm - O Realm que usa o schema mais recente, que deve ser modificado conforme necessário.

    desde

    0.12.0

  • Optional caminho?: string

    O caminho para o arquivo onde o reconhecimento de data center do Realm deve ser armazenado. Para Realms sincronizados, um caminho relativo é usado junto com o AppConfiguration.id | ID do aplicativo e ID do usuário para evitar colisões com outros aplicativos ou usuários. Um caminho absoluto é deixado intocado e, em algumas plataformas (iOS e Android), o aplicativo pode não ter permissões para criar ou abrir o arquivo - as permissões não são validadas. Se um caminho relativo for especificado, ele será relativo a AppConfiguration.baseFilePath.

    desde

    0.10.0

  • Optional somente leitura?: booleano

    Especifica se este Realm deve ser aberto como somente leitura.

    default

    false
    

    desde

    0.10.0

  • Optional schema?: (ObjectClass<AnyRealmObject> | Esquema de objetos)[]

    Especifica todos os Tipo de objeto de Realm neste Realm. Obrigatório ao criar um Realm pela primeira vez neste path. Se omitido, o esquema será lido a partir do Arquivo de Realm existente.

    desde

    0.10.0

  • Optional Versão do esquema?: número

    Se alterar schema , este campo será obrigatório e deverá ser incrementado. Isso se aplica apenas aos Realms locais.

    desde

    0.11.0

  • Optional devecompactar?: ((totalBytes, usedBytes) => boolean)

    A função chamada ao abrir um Realm pela primeira vez durante a vida de um processo para determinar se ele deve ser compactado antes de ser retornado ao usuário.

    Ele retorna true para indicar que deve ser feita uma tentativa de compactar o arquivo. A compactação será ignorada se outro processo estiver acessando-a.

    Parâmetro: totalBytes

    O tamanho total do arquivo (dados + espaço livre).

    Parâmetro: usadoBytes

    O total de bytes usados pelos dados no arquivo.

    Devoluções

    true se o Arquivo de Realm precisar ser compactado antes de ser aberto.

    desde

    2.9.0

    Exemplo

    // compact large files (>100 MB) with more than half is free space
    shouldCompact: (totalBytes, usedBytes) => {
    const oneHundredMB = 100 * 1024 * 1024; // 100 MB
    return totalBytes > oneHundredMB && usedBytes / totalBytes < 0.5;
    }
      • (totalBytes, usadoBytes): booleano
      • A função chamada ao abrir um Realm pela primeira vez durante a vida de um processo para determinar se ele deve ser compactado antes de ser retornado ao usuário.

        Ele retorna true para indicar que deve ser feita uma tentativa de compactar o arquivo. A compactação será ignorada se outro processo estiver acessando-a.

        Parâmetros

        • totalBytes: número

          O tamanho total do arquivo (dados + espaço livre).

        • usadoBytes: número

          O total de bytes usados pelos dados no arquivo.

        Retorna booleano

        true se o Arquivo de Realm precisar ser compactado antes de ser aberto.

        desde

        2.9.0

        Exemplo

        // compact large files (>100 MB) with more than half is free space
        shouldCompact: (totalBytes, usedBytes) => {
        const oneHundredMB = 100 * 1024 * 1024; // 100 MB
        return totalBytes > oneHundredMB && usedBytes / totalBytes < 0.5;
        }
  • Optional sincronizar?: SyncConfiguration

Gerado usando TypeDoc