Crie um RealmObject
envolvendo um Obj
a partir da vinculação.
O Realm gerenciando o objeto.
Os valores das propriedades do objeto na criação.
Static
permitirStatic
Optional
assimétricoComo opção, especifique que o esquema deve sincronizar unidirecionalmente se estiver usando a Flexible Sync ao usar o @realm/babel-plugin.
Static
Optional
incorporadoComo opção, especifique que o esquema é um esquema incorporado ao usar @realm/babel-plugin.
Static
Optional
chave primáriaComo opção, especifique a chave primária do esquema ao usar o @realm/babel-plugin.
Adicione um ouvinte callback
que será chamado quando uma instância de objeto ativo 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 consideradas relevantes para todos os ouvintes registrados no objeto. Em outras palavras: um ouvinte pode disparar mais do que os caminhos-chave especificam, se outros ouvintes com caminhos-chave diferentes estiverem presentes.
Um TypeAssertionError se callback
não for uma função.
wine.addListener((obj, changes) => {
// obj === wine
console.log(`object is deleted: ${changes.deleted}`);
console.log(`${changes.changedProperties.length} properties have been changed:`);
changes.changedProperties.forEach(prop => {
console.log(` ${prop}`);
});
})
wine.addListener((obj, changes) => {
console.log("The wine got deleted or its brand might have changed");
}, ["brand"])
Adicionar o ouvinte é uma operação assíncrona, portanto, a chamada de resposta é invocada na primeira vez para notificar o chamador quando o ouvinte for adicionado. Assim, quando a chamada de resposta for invocada pela primeira vez, ele conterá uma matriz vazia para changes.changedProperties
.
Uma array de pares chave/valor das propriedades do objeto.
Use Object.entries()
Uma array dos nomes das propriedades do objeto.
Use Object.keys()
Retorna todos os objeto vinculados a este objeto no relacionamento especificado.
O tipo dos objetos vinculados ao tipo desse objeto.
O nome da propriedade que referencia objetos do tipo deste objeto.
Os resultados vinculados a esse objeto.
Um AssertionError se o relacionamento não for válido.
O esquema do tipo a que este objeto pertence.
O CanonicalObjectSchema que descreve este objeto.
Remova o ouvinte callback
deste objeto.
Uma função adicionada anteriormente como ouvinte
Um TypeAssertionError se callback
não for uma função.
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.
Optional
_: stringOptional
cache: desconhecidoUm objeto simples.
Gerado usando TypeDoc
Classe base para um Objeto de Realm.
Exemplo
Para definir uma classe
Person
com as propriedadesname
eage
necessárias, defina umstatic schema
:Exemplo
Se estiver usando o @realm/babel-plugin: para definir uma classe
Person
com as propriedadesname
eage
necessárias, elas precisariam ser especificadas no argumento de tipo quando ele estiver sendo construído para permitir definições de modelo somente Typescript :Veja
Esquema de objetos
Type Param
T
- O tipo dessa classe (por exemplo, se sua classe forPerson
,T
também deve serPerson
- essa duplicação é necessária devido à forma como o Typescript funciona)Type Param
RequiredProperties
- Os nomes de quaisquer propriedades desta classe que são necessárias quando uma instância é construída comnew
. Quaisquer propriedades não especificadas serão opcionais e assumirão como padrão um valor nulo sensível se nenhum padrão for especificado em outro lugar.