Abstract Readonly [unscopeables]Um objeto cujas propriedades de verdade são propriedades excluídas das ligações de ambiente "com" dos objetos associados.
Optional [itizer]?: booleanoOptional Readonly [unscopeables]?: booleanoOptional em?: booleanoOptional concat?: booleanoOptional copiarOptional entradas?: booleanoOptional cada?: booleanoOptional BucketAuto?: booleanoOptional filtro, filtro?: booleanoOptional find?: booleanoOptional encontrarOptional Plana?: booleanoOptional mapaOptional paraOptional inclui?: booleanoOptional índice de?: booleanoOptional juntar?: booleanoOptional keys?: booleanoOptional último índice de?: booleanoOptional Tamanho?: booleanoOptional map?: booleanoOptional Pop?: booleanoOptional push?: booleanoOptional reduzir?: booleanoOptional reduzir à direita?: booleanoOptional reverter?: booleanoOptional mudança?: booleanoOptional fatia?: booleanoOptional alguns?: booleanoOptional sort?: booleanoOptional unir?: booleanoOptional para aOptional toOptional unshift?: booleanoOptional values?: booleanoO número de valores.
Um erro como a propriedade de comprimento não pode ser atribuído.
Se null é um valor válido para a coleção.
Se null é um valor válido para a coleção.
Nome do tipo de itens.
O nome do tipo de valores.
Adicione um ouvinte callback que será chamado quando uma instância de collection ativa for alterada.
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.
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.
Um TypeAssertionError se callback não for uma função.
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}`);
});
wines.addListener((collection, changes) => {
console.log("A wine's brand might have changed");
}, ["brand"]);
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 .
O elemento no índice fornecido na array; undefined se não houver nenhum elemento no índice fornecido.
index - O índice do elemento para retornar da array. Se o índice for um número negativo, o elemento em array.length + index será retornado.
Calcula a média dos valores na collection ou da propriedade fornecida entre todos os objetos na collection, ou undefined se a collection estiver vazia.
Suportado apenas para propriedades int, float e double. Os valores de null são totalmente ignorados por este método e não serão contabilizados na média.
Optional propriedade: stringPara uma collection de objeto, a propriedade para obter a média de.
A soma.
Um erro se não existir nenhuma propriedade com o nome ou se a propriedade não for numérica.
Rest ...items: ConcatArray<T>[]Arrays e/ou valores para concatenar em uma nova array.
Uma nova array com os resultados da chamada de uma função fornecida em cada elemento desta array.
Uma nova array com os resultados da chamada de uma função fornecida em cada elemento desta array.
Um iterador com todos os pares chave/valor na collection.
true se a chamada de resposta retornar um valor verdadeiro para cada elemento da collection; caso contrário, false.
predicado - Uma função para testar cada elemento.
predicate.value - O elemento atual sendo processado na collection.
predicate.index - O índice do elemento atual sendo processado na collection.
predicate.array - A collection every foi chamada.
esteArg - Um objeto ao qual a palavra-chave this pode referir-se na função do predicado. Se thisArg for omitido, undefined será utilizado como o valor this .
Optional esteArg : qualquertrue se a chamada de resposta retornar um valor verdadeiro para cada elemento da collection; caso contrário, false.
predicado - Uma função para testar cada elemento.
predicate.value - O elemento atual sendo processado na collection.
predicate.index - O índice do elemento atual sendo processado na collection.
predicate.array - A collection every foi chamada.
esteArg - Um objeto ao qual a palavra-chave this pode referir-se na função do predicado. Se thisArg for omitido, undefined será utilizado como o valor this .
Uma nova array contendo os elementos da collection para a qual a função predicate retornou true.
predicado - Uma função que aceita até três argumentos. O método filter chama a função predicate uma vez para cada elemento na collection.
predicate.value - O elemento atual sendo processado na collection.
predicate.index - O índice do elemento atual sendo processado na collection.
predicate.array - A collection filter foi chamada.
estaArg - Um objeto ao qual a palavra-chave this pode se referir na função predicate . Se thisArg for omitido, undefined será utilizado como o valor this .
Optional esteArg : qualquerUma nova array contendo os elementos da collection para a qual a função predicate retornou true.
predicado - Uma função que aceita até três argumentos. O método filter chama a função predicate uma vez para cada elemento na collection.
predicate.value - O elemento atual sendo processado na collection.
predicate.index - O índice do elemento atual sendo processado na collection.
predicate.array - A collection filter foi chamada.
estaArg - Um objeto ao qual a palavra-chave this pode se referir na função predicate . Se thisArg for omitido, undefined será utilizado como o valor this .
Retorna novos resultados que representam essa collection sendo filtrada pela query fornecida.
Query usada para filtrar objetos da collection.
Rest ...argumentos: desconhecido[]Cada argumento subsequente é usado pelos espaços reservados (por exemplo $0, $1, $2, ...) na query.
Resultados filtrados de acordo com a query fornecida.
Um erro se a query ou qualquer outro argumento passado para este método for inválido.
Atualmente, isso só é suportado para coleções de Objetos de Realm.
let merlots = wines.filtered('variety == "Merlot" && vintage <= $0', maxYear);
O valor do primeiro elemento na array que satisfaz a função de teste fornecida. Caso contrário, undefined é retornado.
predicado - Uma função que aceita até três argumentos. O método find chama a função predicate uma vez para cada elemento na collection.
predicate.value - O valor do elemento.
predicate.index - O índice do elemento.
predicate.obj - O objeto sendo atravessado.
estaArg - Um objeto ao qual a palavra-chave this pode se referir na função predicate . Se thisArg for omitido, undefined será utilizado como o valor this .
Optional esteArg : qualquerO valor do primeiro elemento na array que satisfaz a função de teste fornecida. Caso contrário, undefined é retornado.
predicado - Uma função que aceita até três argumentos. O método find chama a função predicate uma vez para cada elemento na collection.
predicate.value - O valor do elemento.
predicate.index - O índice do elemento.
predicate.obj - O objeto sendo atravessado.
estaArg - Um objeto ao qual a palavra-chave this pode se referir na função predicate . Se thisArg for omitido, undefined será utilizado como o valor this .
Optional esteArg : qualquerO índice do primeiro elemento na array que satisfaz a função de teste fornecida. Caso contrário, -1 é retornado.
predicado - Uma função que aceita até três argumentos. O método findIndex chama a função predicate uma vez para cada elemento na collection.
predicate.value - O valor do elemento.
predicate.index - O índice do elemento.
predicate.obj - O objeto sendo atravessado.
estaArg - Um objeto ao qual a palavra-chave this pode se referir na função predicate . Se thisArg for omitido, undefined será utilizado como o valor this .
Uma nova array com os elementos da sub-array concatenados nela.
depth - o nível de profundidade especificando o quão profundamente uma estrutura de array aninhada deve ser achatada. O padrão é 1.
Uma nova array com cada elemento sendo o resultado da função de retorno de chamada e achatado a uma profundidade de 1.
chamada de resposta - Função que produz um elemento do novo Array, aceitando três argumentos:
callback.currentValue - O elemento atual sendo processado na array.
callback.index - O índice do elemento atual sendo processado na array.
callback.array - A array flatMap foi chamada.
esteArg – Valor a ser usado como este ao executar a chamada de resposta.
Optional esteArg : qualquercallbackfn - Uma função que aceita até três argumentos. forEach chama a função callbackfn uma vez para cada elemento da collection.
callbackfn.value - O elemento atual sendo processado na collection.
callbackfn.index - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection forEach foi chamada.
estaArg - Um objeto ao qual a palavra-chave this pode se referir na função callbackfn . Se thisArg for omitido, undefined será utilizado como o valor this .
Optional fromIndex : númerotrue se searchElement for encontrado na array; caso contrário, false.
searchElement - O elemento a ser pesquisado.
fromIndex - A posição nessa array na qual começar a procurar searchElement . Um valor negativo pesquisa no índice de array.depth + fromIndex por asc.
fromIndex atualmente não é suportado. Então, todas as pesquisas começam no índice 0.
Optional fromIndex : númeroO primeiro índice no qual um determinado elemento pode ser encontrado na collection, ou -1 se não estiver presente.
searchElement - Elemento para localizar na collection.
fromIndex - O índice da collection no qual iniciar a pesquisa. Se omitido, a pesquisa começa no índice 0.
fromIndex atualmente não é suportado. Então, todas as pesquisas começam no índice 0.
Abstract éOptional fromIndex : númeroO último índice no qual um determinado elemento pode ser encontrado na collection, ou -1 se não estiver presente. A collection é pesquisar para trás, começando em fromIndex.
searchElement - Elemento para localizar na collection.
fromIndex - O índice da collection no qual iniciar a pesquisa. Se omitido, a pesquisa começa no último índice.
Uma nova array contendo os resultados de chamar a função callbackfn em cada elemento da collection.
callbackfn - Uma função que aceita até três argumentos. O método map chama a função callbackfn uma vez para cada elemento na collection.
callbackfn.value - O elemento atual sendo processado na collection.
callbackfn.index - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection map foi chamada.
estaArg - Um objeto ao qual a palavra-chave this pode se referir na função callbackfn . Se thisArg for omitido, undefined será utilizado como o valor this .
Retorna o valor máximo dos valores na collection ou da propriedade fornecida entre todos os objetos na collection, ou undefined se a collection estiver vazia.
Suportado apenas para propriedades int, float, double e data. Os valores null são totalmente ignorados por este método e não serão retornados.
Optional propriedade: stringPara uma coleção de objetos, a propriedade para obter o máximo de.
O valor máximo.
Um erro se não existir nenhuma propriedade com o nome ou se a propriedade não for numérica/data.
Retorna o valor mínimo dos valores na collection ou da propriedade fornecida entre todos os objetos na collection, ou undefined se a collection estiver vazia.
Suportado apenas para propriedades int, float, double e data. Os valores null são totalmente ignorados por este método e não serão retornados.
Optional propriedade: stringPara uma coleção de objetos, a propriedade para usar o mínimo de.
O valor mínimo.
Um TypeAssertionError se não existir nenhuma propriedade com o nome ou se a propriedade não for numérica/data.
O valor que resulta da redução.
callbackfn - Uma função que aceita até quatro argumentos. O método reduce chama a função callbackfn uma vez para cada elemento na collection.
callbackfn.pre preferencesValue - O valor retornado anteriormente na última invocação da função callbackfn , ou initialValue, se fornecido. (Veja abaixo.)
callbackfn.currentValue - O elemento atual sendo processado na collection.
callbackfn.currentIndex - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection reduce foi chamada.
initialValue - Se initialValue for especificado, ele será usado como valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de elemento.
O valor que resulta da redução.
callbackfn - Uma função que aceita até quatro argumentos. O método reduce chama a função callbackfn uma vez para cada elemento na collection.
callbackfn.pre preferencesValue - O valor retornado anteriormente na última invocação da função callbackfn , ou initialValue, se fornecido. (Veja abaixo.)
callbackfn.currentValue - O elemento atual sendo processado na collection.
callbackfn.currentIndex - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection reduce foi chamada.
initialValue - Se initialValue for especificado, ele será usado como valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de elemento.
O valor que resulta da redução.
callbackfn - Uma função que aceita até quatro argumentos. O método reduce chama a função callbackfn uma vez para cada elemento na collection.
callbackfn.pre preferencesValue - O valor retornado anteriormente na última invocação da função callbackfn , ou initialValue, se fornecido. (Veja abaixo.)
callbackfn.currentValue - O elemento atual sendo processado na collection.
callbackfn.currentIndex - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection reduce foi chamada.
initialValue - Se initialValue for especificado, ele será usado como valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de elemento.
O valor que resulta da redução.
callbackfn - Uma função que aceita até quatro argumentos. O método reduceRight chama a função callbackfn uma vez para cada elemento na collection.
callbackfn.pre preferencesValue - O valor retornado anteriormente na última invocação da função callbackfn , ou initialValue, se fornecido. (Veja abaixo.)
callbackfn.currentValue - O elemento atual sendo processado na collection.
callbackfn.currentIndex - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection reduceRight foi chamada.
initialValue - Se initialValue for especificado, ele será usado como valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de elemento.
O valor que resulta da redução.
callbackfn - Uma função que aceita até quatro argumentos. O método reduceRight chama a função callbackfn uma vez para cada elemento na collection.
callbackfn.pre preferencesValue - O valor retornado anteriormente na última invocação da função callbackfn , ou initialValue, se fornecido. (Veja abaixo.)
callbackfn.currentValue - O elemento atual sendo processado na collection.
callbackfn.currentIndex - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection reduceRight foi chamada.
initialValue - Se initialValue for especificado, ele será usado como valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de elemento.
O valor que resulta da redução.
callbackfn - Uma função que aceita até quatro argumentos. O método reduceRight chama a função callbackfn uma vez para cada elemento na collection.
callbackfn.pre preferencesValue - O valor retornado anteriormente na última invocação da função callbackfn , ou initialValue, se fornecido. (Veja abaixo.)
callbackfn.currentValue - O elemento atual sendo processado na collection.
callbackfn.currentIndex - O índice do elemento atual sendo processado na collection.
callbackfn.array - A collection reduceRight foi chamada.
initialValue - Se initialValue for especificado, ele será usado como valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de elemento.
Remova o ouvinte callback da instância da collection.
chamada de resposta que foi adicionada anteriormente como um ouvinte por meio do método collection.addListener .
um TypeAssertionError Se callback não for uma função.
Optional início: númeroOptional fim: númeroUma nova matriz contendo os elementos entre os índices inicial e final.
start - Índice baseado em zero no qual iniciar a extração.
end - Índice com base zero no qual encerrar a extração. Ele extrai até, mas não incluindo, end.
Crie um snapshot congelado da coleção.
Os valores adicionados e removidos da coleção original não serão refletidos nos resultados retornados por este método, inclusive se os valores das propriedades forem alterados para fazer com que correspondam ou não aos filtros aplicados.
Este não é um snapshot detalhado. Os objetos de Realm contidos neste snapshot continuarão a ser atualizados à medida que as alterações forem feitas neles e, se forem excluídos do Realm, serão substituídos por null nos respectivos índices.
Resultados que não serão atualizados ao vivo.
Optional esteArg : qualquertrue se a chamada de resposta retornar um valor verdadeiro para qualquer elemento da collection; caso contrário, false.
predicado - Uma função para testar cada elemento.
predicate.value - O elemento atual sendo processado na collection.
predicate.index - O índice do elemento atual sendo processado na collection.
predicate.array - A collection every foi chamada.
esteArg - Um objeto ao qual a palavra-chave this pode referir-se na função do predicado. Se thisArg for omitido, undefined será utilizado como o valor this .
Retorna novos resultados que representam uma visualização ordenada desta collection.
Uma coleção de Objetos de Realm pode ser classificada em uma ou mais propriedades desses objetos, ou de propriedades de objetos vinculados por esses objetos. Para ordenar por uma única propriedade, basta passar o nome dessa propriedade para sorted() , opcionalmente seguido por um booleano indicando se a classificação deve ser revertida. Para mais de uma propriedade, você deve passar uma array de descritores de classificação que listam quais propriedades classificar.
Collection de outros tipos classificam nos próprios valores, em vez de propriedade dos valores, e, portanto, nenhum nome de propriedade ou descritores de classificação deve ser fornecido.
Optional reverso: booleanoClassifique em ordem decrescente em vez de ascendente. Pode não ser aplicado se descriptor for uma array de descritores de ordenação.
Resultados classificados de acordo com os argumentos passados.
Um erro se uma propriedade especificada não existir.
Retorna novos resultados que representam uma visualização ordenada desta collection.
Uma coleção de Objetos de Realm pode ser classificada em uma ou mais propriedades desses objetos, ou de propriedades de objetos vinculados por esses objetos. Para ordenar por uma única propriedade, basta passar o nome dessa propriedade para sorted() , opcionalmente seguido por um booleano indicando se a classificação deve ser revertida. Para mais de uma propriedade, você deve passar uma array de descritores de classificação que listam quais propriedades classificar.
Collection de outros tipos classificam nos próprios valores, em vez de propriedade dos valores, e, portanto, nenhum nome de propriedade ou descritores de classificação deve ser fornecido.
O(s) nome(s) da propriedade(s) para classificar a coleção.
Resultados classificados de acordo com os argumentos passados.
Um erro se uma propriedade especificada não existir.
Retorna novos resultados que representam uma visualização ordenada desta collection.
Uma coleção de Objetos de Realm pode ser classificada em uma ou mais propriedades desses objetos, ou de propriedades de objetos vinculados por esses objetos. Para ordenar por uma única propriedade, basta passar o nome dessa propriedade para sorted() , opcionalmente seguido por um booleano indicando se a classificação deve ser revertida. Para mais de uma propriedade, você deve passar uma array de descritores de classificação que listam quais propriedades classificar.
Collection de outros tipos classificam nos próprios valores, em vez de propriedade dos valores, e, portanto, nenhum nome de propriedade ou descritores de classificação deve ser fornecido.
O(s) nome(s) da propriedade(s) para classificar a coleção.
Optional reverso: booleanoResultados classificados de acordo com os argumentos passados.
Um erro se uma propriedade especificada não existir.
Calcula a soma dos valores na collection ou da propriedade fornecida entre todos os objetos na collection, ou 0 se a collection estiver vazia.
Suportado apenas para propriedades int, float e double. Os valores null são totalmente ignorados por este método.
Optional propriedade: stringPara uma coleção de objetos, a propriedade para obter a soma.
A soma.
Um erro se não existir nenhuma propriedade com o nome ou se a propriedade não for numérica.
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.
Uma array de objetos simples.
Gerado usando TypeDoc
Uma OrderedCollection é uma sequência uniforme de valores de qualquer um dos tipos que podem ser armazenados como propriedade de Objeto de Realm. Ele pode ser acessado de qualquer uma das maneiras que uma array JavaScript normal pode, incluindo assinatura, enumeração com
for-ofe assim por diante.Veja
Array