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

Construtores

Métodos

  • Geradorde Retornos<[string, T], qualquer, desconhecido>

    Um iterador com todas as entradas no dicionário.

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

    Parâmetros

    • chamada de resposta: DicionárioChangeCallback<T>

      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 e oldModifications informam os índices na collection antes de a mudança acontecer, enquanto insertions e newModifications informam os índices na nova versão da collection.

    Lança

    Um TypeAssertionError se callback não for uma função.

    Exemplo

    wines.addListener((collection, changes) => {
    // collection === wines
    console.log(`${changes.insertions.length} insertions`);
    console.log(`${changes.oldModifications.length} oldModifications`);
    console.log(`${changes.newModifications.length} newModifications`);
    console.log(`${changes.deletions.length} deletions`);
    console.log(`new size of collection: ${collection.length}`);
    });

    Exemplo

    wines.addListener((collection, changes) => {
    console.log("A wine's brand might have changed");
    }, ["brand"]);

    Observação

    Adicionar o ouvinte é uma operação assíncrona, portanto, o chamada de resposta de chamada é invocado na primeira vez para notificar o chamador quando o ouvinte for adicionado. Assim, quando a chamada de resposta de resposta for invocada pela primeira vez, ela conterá arrays vazias para cada propriedade no objeto changes .

  • Geradorde Retornos<[string, T], qualquer, desconhecido>

    Um iterador com todos os pares chave/valor no dicionário.

    Veja

    Array.prototype.entries

    desde

    10.5.0 @ts-expect-error Estamos expondo métodos no namespace de entradas do usuário final

  • 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

  • Geradorde devolução<string, qualquer, desconhecido>

    Um iterador com todos os valores no dicionário.

    Veja

    Array.prototype.keys

    desde

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

  • 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

  • Remova todos os ouvintes callback da instância de coleção.

    Retorna nulo

  • 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

  • Geradorde Devoluções<T, qualquer, desconhecido>

    Um iterador com todos os valores no dicionário.

    Veja

    Array.prototype.values

    desde

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

Gerado usando TypeDoc