collection<KeyType, ValueType, EntradaType, T, ChangeCallbackType>Abstract

classe base abstrata contendo métodos compartilhados por Realm List, Dicionário, Resultados e RealmSet.

Uma collection sempre reflete o estado atual do Realm. A única exceção a isso é ao usar enumeração for...in ou for...of , que sempre enumerará os objetos que correspondem à query quando a enumeração for iniciada, mesmo que alguns deles sejam excluídos ou modificados para serem excluídos pelo filtro durante a enumeração.

desde

0.11.0

Parâmetros de tipo

  • KeyType = desconhecido

  • ValueType = desconhecido

  • EntradaType = [KeyType, ValueType]

  • T = ValueType

  • ChangeCallbackType = desconhecido

hierarquia (visualização completa)

Implementos

  • Iterável<t>

Construtores

Métodos

  • Este é o mesmo método que o método Collection.values . Sua presença torna as collections iteráveis , portanto, podem ser usadas com loops ES6 for-of , operadores de dispersão ... e muito mais.

    Retorna o Iterador<T, qualquer, indefinido>

    Um iterável de cada valor na collection.

    Veja

    Símbolo.itizer e o protocolo iterável

    Exemplo

    for (let object of collection) {
    // do something with each object
    }

    desde

    0.11.0

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

    Parâmetros

    • chamada de resposta: ChangeCallbackType

      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 .

  • Verifica se a collection não foi excluída e faz parte de um Realm válido.

    Retorna booleano

    true se a collection puder ser acessada com segurança.

    desde

    0.14.0

  • Retorna o iterável<KeyType>

    Um iterador com todas as chaves da collection.

    Veja

    Array.prototype.keys

    desde

    0.11.0

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

    Retorna nulo

  • Remova o ouvinte callback da instância da collection.

    Parâmetros

    Retorna nulo

    Lança

    um TypeAssertionError Se callback não for uma função.

  • Retorna o iterável<ValueType>

    Um iterador com todos os valores na collection.

    Veja

    Array.prototype.keys

    desde

    0.11.0

Gerado usando TypeDoc