Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

Armadilhas `get` e `set` de `Proxy` e parâmetro `receiver`

As armadilhas `get` e `set` intercetam a leitura e a escrita de propriedades. Passar `receiver` a `Reflect` preserva o recetor da operação original.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

const proxy = new Proxy(target, {
  get(target, key, receiver) {
    return Reflect.get(target, key, receiver);
  },
  set(target, key, value, receiver) {
    return Reflect.set(target, key, value, receiver);
  },
});

Em new Proxy(target, handler), get(target, key, receiver) interceta a operação interna [[Get]] e devolve o valor lido. set(target, key, value, receiver) interceta [[Set]] e indica se a escrita foi bem-sucedida. key é uma cadeia de caracteres ou um Symbol. Se a armadilha correspondente não existir, o proxy encaminha a operação para target com o mesmo receiver.

target é o objeto envolvido pelo proxy. receiver é o valor de this fornecido ao getter ou ao setter. Num acesso direto normal é o proxy; se o acesso chegar ao proxy pela cadeia de protótipos, pode ser o objeto que herda do proxy. Numa escrita normal de uma propriedade de dados, a propriedade pode ser criada ou atualizada em receiver.

Para preservar esse comportamento, devolve Reflect.get(target, key, receiver) e Reflect.set(target, key, value, receiver) nas armadilhas. Se omitires receiver, estas chamadas usam target como recetor. Ler ou atribuir diretamente target[key] também usa target como recetor. Repetir a operação no próprio proxy dentro da armadilha pode voltar a invocá-la e causar recursão.

O valor devolvido pela armadilha set é convertido num booleano. true indica sucesso, mas, por si só, não escreve nada. Se [[Set]] devolver false, uma atribuição em modo estrito lança um TypeError, uma atribuição fora desse modo não lança um erro por esse motivo e Reflect.set devolve false.

O motor impõe regras para as propriedades próprias não configuráveis de target. Para uma propriedade de dados não gravável, get tem de devolver o mesmo valor, segundo Object.is, e set não pode indicar sucesso para um valor diferente. Para uma propriedade de acesso sem getter, get tem de devolver undefined; sem setter, set não pode indicar sucesso. Violar estas regras lança um TypeError, mesmo fora do modo estrito.

Exemplos

{
  const target = {
    points: 1,
    get score() { return this.points; },
    set score(value) { this.points = value; },
  };

  const proxy = new Proxy(target, {
    get(target, key, receiver) {
      return Reflect.get(target, key, receiver);
    },
    set(target, key, value, receiver) {
      return Reflect.set(target, key, value, receiver);
    },
  });

  const child = Object.create(proxy);
  console.log(`before: ${child.score}`);
  child.score = 7;
  console.log(`child: ${child.score}`);
  console.log(`target: ${target.score}`);
}

Resultado

before: 1
child: 7
target: 1

No getter e no setter de `score`, `this` é `child`. A primeira leitura encontra `points` por herança; o setter cria `child.points` como propriedade própria e deixa `target.points` inalterado.

Lições relacionadas

  • JavaScript · Lição 29 · Avançado · Versão: 4

Fontes