setter

Sintaxe

{set prop(val) { . . . }}
{set [expression](val) { . . . }}

Parmetros

prop

Nome da propriedade ligada a funo.

val

Um apelido para varivel que ser atribuidada a prop.

expression

Iniciando com ECMAScript 6, voc pode usar tambm expresses para computar o nome da propriedade a ser definida na funo.

Descrio

Em JavaScript, um setter pode ser usado para executar uma funo sempre que se tenta mudar uma propriedade especfica. Setters so geralmente usados em conjunto com getters, para criar um tipo de pseudo-propriedade. No entanto impossvel ter-se um setter para uma propriedade que contenha um valor real.

Observe os seguintes itens ao trabalhar com a sintaxe set:

• Ele pode ter um identificador que um nmero ou uma string;
• Deve ter exatamente um parmetro (para mais informaes, acesse: Mudana do ES5 incompatvel: funes getter e setter literais tem exatamemente zero ou um parmetros);
• No deve ter a mesma nomenclatura seja ela para propriedades ou funo. ({ set x(v) { }, set x(v) { } } e { x: ..., set x(v) { } } proibido.)

Um setter pode ser deletado usando o operator delete.

Exemplos

Definindo um setter em new Objects no inicializador

Vai definir um pseudo-property current para este objeto, quando atribuido um valor, vai mudar log com o valor passado:

var o = {
  set current(str) {
    this.log[this.log.length] = str;
  },
  log: [],
};

Observe que current no est definido e qualquer tentativa de acesso ir resultar em undefined.

Removendo um setter com o operador delete

Se voc deseja remover o setter, poder usar somente o delete:

delete o.current;

Definindo um setter para um Object existente usando o defineProperty

Para adicionar um setter para um Object existentem mais tarde, use Object.defineProperty().

var o = { a: 0 };

Object.defineProperty(o, "b", {
  set: function (x) {
    this.a = x / 2;
  },
});

o.b = 10; // Runs the setter, which assigns 10 / 2 (5) to the 'a' property
console.log(o.a); // 5

Usando um nome de propriedade computada

var expr = "foo";

var obj = {
  baz: "bar",
  set [expr](v) {
    this.baz = v;
  },
};

console.log(obj.baz); // "bar"
obj.foo = "baz"; // run the setter
console.log(obj.baz); // "baz"

Especificaes

Compatibilidade com navegadores

SpiderMonkey-specific notes

• Starting with JavaScript 1.8.1, setters are no longer called when setting properties in object and array initializers.
• From SpiderMonkey 38 on, a setter with a rest parameter is a SyntaxError as per the ES6 specification.

See also

• getter
• delete
• Object.defineProperty()
• Object.prototype.__defineGetter__()
• Object.prototype.__defineSetter__()
• Defining Getters and Setters in JavaScript Guide