Estende-se
Membros
O número de valores na collection.
Tipo:
number
Se null
é um valor válido para a coleção.
Tipo:
boolean
O tipo de valores na collection.
Tipo:
string
Métodos
- propriedade
- Tipo:
string
O nome da propriedade.
- valor
- Tipo:
string
O valor da propriedade atualizado.
-
Error
Se não existir nenhuma propriedade com o nome.
Objeto de atualização em massa na collection.
Parâmetros:
Lança:
Métodos herdados
- chamada de resposta
- Tipo:
function
Uma função a ser chamada quando ocorrem alterações. A função de chamada de resposta é chamada com dois argumentos:
collection
: a instância da collection que mudou,changes
: um dicionário com chavesinsertions
,newModifications
,oldModifications
edeletions
, cada um contendo uma lista de índices na coleção que foram inseridos, atualizados ou excluídos respectivamente.deletions
eoldModifications
são índices da coleção antes da alteração acontecer, enquantoinsertions
enewModifications
são índices da nova versão da coleção.
-
Error
Se
callback
não for uma função.
- propriedade opcional
- Tipo:
string
Para uma collection de objeto, a propriedade para obter a média de.
-
Error
Se nenhuma propriedade com o nome existir ou se a propriedade não for numérica.
- chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto da collection. Se esta função retornar
true
para cada objeto, este método retornarátrue
. Esta função usa três argumentos:object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- esteArg opcional
- Tipo:
object
O valor de
this
quandocallback
é chamado.- Query
- Tipo:
string
Query usada para filtrar objetos da collection.
- arg opcional repetível
- Tipo:
any
Cada argumento subsequente é usado pelos espaços reservados (por exemplo
$0
,$1
,$2
, ...) na query.-
Error
Se a query ou qualquer outro argumento passado para este método for inválido.
- chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto da collection. Se esta função retornar
true
, esse objeto será retornado por este método. Esta função usa três argumentos:object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- esteArg opcional
- Tipo:
object
O valor de
this
quandocallback
é chamado.- chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto da collection. Se esta função retornar
true
, o índice deste objeto será retornado por este método. Esta função usa três argumentos:object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- esteArg opcional
- Tipo:
object
O valor de
this
quandocallback
é chamado.- chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto da collection. Esta função usa três argumentos:
object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- esteArg opcional
- Tipo:
object
O valor de
this
quandocallback
é chamado.- objeto
- Tipo:
T
O valor a pesquisar na collection.
-
Error
Se o argumento for um
Realm.Object
que não pertence ao mesmo Realm que a collection.
- separador opcional
- Tipo:
string
- Padrão:
","
Uma string para separar os valores de retorno do método
toString()
que está sendo chamado em cada objeto da collection.- chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto da collection. Esta função usa três argumentos:
object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- esteArg opcional
- Tipo:
object
O valor de
this
quandocallback
é chamado.- propriedade opcional
- Tipo:
string
Para uma coleção de objetos, a propriedade para obter o máximo de.
-
Error
Se não existir nenhuma propriedade com o nome ou se a propriedade não for numérica/data.
- propriedade opcional
- Tipo:
string
Para uma coleção de objetos, a propriedade para usar o mínimo de.
-
Error
Se não existir nenhuma propriedade com o nome ou se a propriedade não for numérica/data.
- chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto da collection. Esta função usa quatro argumentos:
previousValue
– O valor retornado anteriormente na última invocação da chamada de resposta, ouinitialValue
, se fornecido.object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- initialValue opcional
- Tipo:
object
O valor a ser usado como primeiro argumento para a primeira chamada do
callback
.-
TypeError
Se a collection estiver vazia e nenhum
initialValue
foi fornecido.
- Se a collection consistir em um único objeto e nenhum
initalValue
tiver sido fornecido, esse objeto será retornado. - Se a collection estiver vazia,
initialValue
deverá ser fornecido e será retornado. - chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto, da direita para a esquerda, na collection. Esta função usa quatro argumentos:
previousValue
– O valor retornado anteriormente na última invocação da chamada de resposta, ouinitialValue
, se fornecido.object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- initialValue opcional
- Tipo:
object
O valor a ser usado como primeiro argumento para a primeira chamada do
callback
.-
TypeError
Se a collection estiver vazia e nenhum
initialValue
foi fornecido.
- Se a collection consistir em um único objeto e nenhum
initalValue
tiver sido fornecido, esse objeto será retornado. - Se a collection estiver vazia,
initialValue
deverá ser fornecido e será retornado. - chamada de resposta
- Tipo:
function
chamada de resposta que foi adicionada anteriormente como um ouvinte através do método
addListener
.-
Error
Se
callback
não for uma função.
- iniciar opcional
- Tipo:
number
- Padrão:
0
O índice inicial. Se negativo, o índice inicial será contado a partir do final da coleta.
- end opcional
- Tipo:
number
O índice final. Os objetos até o índice final, mas não incluindo, serão incluídos no valor de retorno. Se negativo, o índice final será contado a partir do final da collection. Se omitido, todos os objetos do índice inicial serão incluídos no valor de retorno.
-
Error
Ao tirar snapshots de uma collection de tipos primitivos.
- chamada de resposta
- Tipo:
function
Função a ser executada em cada objeto da collection. Se esta função retornar
true
, este método retornarátrue
. Esta função usa três argumentos:object
– O objeto atual que está sendo processado na collection.index
– O índice do objeto que está sendo processado na collection.collection
– A coleção em si.
- esteArg opcional
- Tipo:
object
O valor de
this
quandocallback
é chamado.- descritor opcional
- Tipo:
string
ou[SortDescriptor, ...]
O(s) nome(s) da propriedade(s) para classificar a coleção.
- reverter opcional
- Tipo:
boolean
- Padrão:
false
Classifique em ordem decrescente em vez de ascendente. Não pode ser fornecido se
descriptor
for uma array de descritores de classificação.-
Error
Se uma propriedade especificada não existir.
- propriedade opcional
- Tipo:
string
Para uma coleção de objetos, a propriedade para obter a soma.
-
Error
Se nenhuma propriedade com o nome existir ou se a propriedade não for numérica.
Iterator<T>
Este é o mesmo método que o método values()
. Sua presença torna as collection iteráveis, portanto, podem ser usadas com loops ES6 for-of
, operadores de dispersão ...
e muito mais.
Iterator<T>
de cada Objeto de Realm na collection
Exemplo:
for (let object of collection) {
// do something with each object
}
Adicione um ouvinte callback
que será chamado quando uma instância de collection ativa for alterada.
Parâmetros:
Lança:
Exemplo:
wines.addListener((collection, changes) => {
// collection === wines
console.log(`${changes.insertions.length} insertions`);
console.log(`${changes.modifications.length} modifications`);
console.log(`${changes.deletions.length} deletions`);
console.log(`new size of collection: ${collection.length}`);
});
number
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.
Parâmetros:
Lança:
number
a soma.
Iterator<T>
Iterator<T>
de cada par [index, object]
na collection
boolean
Parâmetros:
boolean
representando se callback
retornou true
para cada objeto na collection.
Realm.Results<T>
Retorna novos resultados que representam essa coleção sendo filtrada pela consulta fornecida.
Parâmetros:
Lança:
Realm.Results<T>
filtrado de acordo com a query fornecida. Atualmente, isso só é suportado para collection de objeto de Realm. Consulte query para obter detalhes sobre a query.
Exemplo:
let merlots = wines.filtered('variety == "Merlot" && vintage
T
ou undefined
Parâmetros:
T
ou undefined
se o callback
não retornou true
para nenhum objeto na collection.
number
Parâmetros:
number
representando o índice onde o callback
retornou true
ou -1
se true
nunca foi retornado.
Parâmetros:
number
Encontra o índice do objeto fornecido na collection.
Parâmetros:
Lança:
number
representando o índice onde o valor foi encontrado ou -1
se não estiver na collection.
boolean
Verifica se esta collection está vazia.
Retorna:boolean
indicando se a collection está vazia ou não.
boolean
Verifica se a collection não foi excluída e faz parte de um Realm válido.
Retorna:boolean
indicando se a collection pode ser acessada com segurança.
string
Une todos os objetos da collection em uma string.
Parâmetros:
string
Iterator<T>
Iterator<T>
de cada índice na collection
[any, ...]
Parâmetros:
[any, ...]
– os valores de retorno de callback
depois de ser chamado em cada objeto da collection.
number
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.
Parâmetros:
Lança:
number
o valor máximo.
number
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.
Parâmetros:
Lança:
number
o valor mínimo.
any
Parâmetros:
Lança:
any
– o valor retornado pela invocação final de callback
, exceto para os seguintes casos especiais:
any
Parâmetros:
Lança:
any
– o valor retornado pela invocação final de callback
, exceto para os seguintes casos especiais:
Remova todos os ouvintes callback
da instância de coleção.
Remova o ouvinte callback
da instância da collection.
Parâmetros:
Lança:
[T, ...]
Parâmetros:
[T, ...]
contendo os objetos do índice inicial até, mas não incluindo, o índice final.
Realm.Results<T>
Crie um snapshot da collection.
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.
Lança:
Realm.Results<T>
que não será atualizado ao vivo.
boolean
Parâmetros:
boolean
– true
quando callback
retorna true
para um objeto na collection, caso contrário false
.
Realm.Results<T>
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.
Parâmetros:
Lança:
Realm.Results<T>
classificado de acordo com os argumentos passados.
Exemplos::
// Sort wines by age
wines.sorted('age')
// Sort wines by price in descending order, then sort ties by age in
// ascending order
wines.sorted([['price', false], ['age']])
// Sort a list of numbers in ascending order
let sortedPrices = wine.pricesSeen.sort()
// Sort people by how expensive their favorite wine is
people.sort("favoriteWine.price")
number
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.
Parâmetros:
Lança:
number
a soma.
Iterator<T>
Iterator<T>
de cada Objeto de Realm na collection