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

Classe base abstrata contendo métodos compartilhados pela Lista, Dicionário e Resultados do Realm .

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

Métodos

  • 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 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 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

  • 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.

Gerado usando TypeDoc