Dicionário de classes<T>

As instâncias desta classe são retornadas ao acessar propriedades de objetos cujo tipo é "Dictionary"

Os dicionários se comportam principalmente como um objeto JavaScript, ou seja, como um par chave/valor onde a chave é uma string.

Parâmetros de tipo

  • T = desconhecido

hierarquia (visualização completa)

Indexável

[chave: string]: T

@ts-expect-error Estamos expondo métodos no namespace de chaves dos usuários finais

Métodos

  • Adicione um ouvinte callback que será chamado quando uma instância de collection ativa for alterada.

    Parâmetros

    • chamada de resposta: DictionChangeCallback

      Uma função a ser chamada quando ocorrem alterações.

    • Optional keyPaths: string | string[]

      Indica um limite inferior nas alterações relevantes para o ouvinte. Esse é um limite inferior, pois, se vários ouvintes forem adicionados (cada um com seu próprio keyPaths), a união desses caminhos-chave determinará as alterações que são consideradas relevantes para todos os ouvintes registrados na collection. Em outras palavras: um ouvinte pode disparar mais do que os caminhos-chave especificam, se outros ouvintes com caminhos-chave diferentes estiverem presentes.

    Retorna nulo

    Observação

    deletions and oldModificationsreport the indices in the collection before the change happened, whileinserçõesandnewModificationsreport the indices into the new version of the collection. @throws A {@link TypeAssertionError} ifchamada de resposta is not a function. @example wines.addListener((collection, changes) => { // collection === wines console.log(${changes.insertions.depth} inserções); console.log(${changes.oldModifications.depth} oldModifications); console.log(${changes.newModifications.depth} newModifications); console.log(${changes.deletions.depth} exclusões); console.log(novo tamanho da collection: ${collection.depth}); }); @example wines.addListener((collection, changes) => { console.log("A wine's brand might have changed"); }, ["brand"]); @note Adding the listener is an asynchronous operation, so the callback is invoked the first time to notify the caller when the listener has been added. Thus, when the callback is invoked the first time it will contain empty arrays for each property in the alterações' evento.

  • Verifica se este dicionário não foi excluído e faz parte de um Realm válido.

    Retorna booleano

    true se o dicionário puder ser acessado com segurança.

    desde

    0.14.0 @ts-expect-error Estamos expondo métodos no namespace das chaves do usuário final

  • Remove elementos do dicionário, com as chaves fornecidas. Isso não lança se as chaves já estiverem faltando no dicionário.

    Parâmetros

    • chave: string | string[]

      A chave a ser removida.

    Retorna isso

    O dicionário

    Lança

    Um AssertionError se não estiver dentro de uma transação de escrita.

    desde

    10.6.0 @ts-expect-error Estamos expondo métodos no namespace de chaves dos usuários finais

  • Adiciona um ou mais elementos com chave e valor especificados ao dicionário ou atualiza o valor se a chave existir.

    Parâmetros

    • elementos: {
          [chave: string]: T;
      }

      O objeto do(s) elemento(s) a ser adicionado(s).

      • [chave: string]: T

    Retorna isso

    O dicionário.

    Lança

    um AssertionError Se não estiver dentro de uma transação de escrita, o objeto contiver chaves de símbolo ou se algum valor violar restrições de tipos.

    desde

    10.6.0 @ts-expect-error Estamos expondo métodos no namespace de chaves dos usuários finais

  • Adiciona um elemento com a chave e o valor especificados ao dicionário ou atualiza o valor se a chave existir.

    Parâmetros

    • chave: string

      A chave do elemento a ser adicionado.

    • valor : T

      O valor do elemento a ser adicionado.

    Retorna isso

    O dicionário.

    Lança

    uma AssertionError Se não estiver dentro de uma transação de escrita, a chave for um símbolo ou se o valor violar restrições de tipo.

    desde

    12.0.0

  • A representação de objeto simples para serialização JSON. Use bibliotecas de serialização JSON circular, como @ongap/estruturado-clone e planas , para definir em strings entidades do Realm que possuem estruturas circulares.

    Parâmetros

    • Optional _: string
    • Optional cache: desconhecido

    Retorna defaultObject

    Um objeto simples. @ts-expect-error Estamos expondo métodos no namespace de chaves dos usuários finais

Gerado usando TypeDoc