Uma representação lógica de contador para executar atualizações numéricas que precisam ser sincronizadas como eventos sequencialmente consistentes em vez de reatribuições individuais do número.

Por exemplo, o cliente offline 1 e o cliente 2 , que veem Counter.value como 0, podem chamar Counter.increment(1). Uma vez online, o valor convergirá para 2.

Os tipos de contador não são suportados como:

  • Mixed values
  • Chaves primárias
  • Por dentro de collections
  • Argumentos de query para espaços reservados (por exemplo $0) em filter()
    • Se você precisar usar o valor de Counter ao filtrar, use Counter.value.

Declarar um contador

Um esquema de propriedade é declarado como:

  • "counter"
  • { type: "int", presentation: "counter" }

Criar um contador

Use um number ao criar seu contador em um Realm.Object.

realm.write(() => {
realm.create(MyObject, { _id: "123", counter: 0 });
});

Atualizando a contagem

Use os métodos de instância para atualizar a contagem subjacente.

Anulabilidade

O esquema de propriedade acima pode ser estendido para permitir um contador anulável. Um Counter nunca armazena null valores em si, mas a propriedade contador no Realm.Object (por exemplo myRealmObject.myCounter) pode ser null.

Para criar um contador a partir de um valor null anterior ou para redefinir um contador anulável para null, use UpdateMode.Modified ou UpdateMode.All.

realm.write(() => {
realm.create(MyObject, { _id: "123", counter: 0 }, UpdateMode.Modified);
});

Construtores

Acessores

Métodos

Construtores

Acessores

  • obter valor(): número
  • A contagem atual.

    Retorna número

Métodos

  • Diminua a contagem.

    Parâmetros

    • Optional por: número

      O valor pelo qual diminuir. (Padrão: 1)

    Retorna nulo

  • Incremente a contagem.

    Parâmetros

    • Optional por: número

      O valor pelo qual incrementar. (Padrão: 1)

    Retorna nulo

  • Redefinir a contagem.

    Parâmetros

    • valor: número

      O valor para o qual redefinir a contagem.

    Retorna nulo

    Aviso

    Ao contrário increment e decremento, definir a contagem se comporta como atualizações individuais regulares no valor subjacente.

Gerado usando TypeDoc