getter

Sintaxe

{get prop() { ... } }
{get [expression]() { ... } }

Parmetros

prop

O nome da propriedade qual a funo dada ser associada.

expression

A partir do ECMAScript 6, voc pode tambm utilizar expresses para um nome computado de uma propriedade para associar funo dada.

Descrio

s vezes desejvel que se permita acesso a uma propriedade que retorna um valor computado dinamicamente, ou voc pode querer refletir o status de uma varivel interna sem requerer o uso de chamadas de mtodo explcitas. Em Javascript, isso pode ser feito com o uso de um getter. No possvel simultaneamente ter um getter associado a uma propriedade e a mesma possuir um valor, embora seja possvel usar um getter e um setter em conjunto para criar algo como uma pseudo-propriedade.

Note o seguinte quando for trabalhar com a sintaxe get:

• Pode haver um identificador que seja um nmero ou uma string;
• Deve haver exatamente zero parmetros (veja Incompatible ES5 change: literal getter and setter functions must now have exactly zero or one arguments para mais informaes)
• No deve haver mais de um getter para a mesma propriedade nem uma propriedade comum como o mesmo nome do getter ({ get x() { }, get x() { } } and { x: ..., get x() { } } so proibidos).

Um getter pode ser removido usando o operador delete.

Exemplos

Definindo um getter em novos objetos em inicializadores de objetos

O exemplo abaixo ir criar a pseudo-propriedade latest para o objeto obj, que ir retornar o ltimo item do array em log.

var log = ["test"];
var obj = {
  get latest() {
    if (log.length == 0) return undefined;
    return log[log.length - 1];
  },
};
console.log(obj.latest); // Retornar "test".

Note que a tentativa de atribuir um valor a latest no ir alter-la.

Removendo um getter usando o operador delete

Se voc quer remover um getter, voc pode apenas utilizar delete.

delete obj.latest;

Definindo um getter em objetos existentes usando defineProperty

Para adicionar um getter a um objeto existente a qualquer momento, use Object.defineProperty().

var o = { a: 0 };

Object.defineProperty(o, "b", {
  get: function () {
    return this.a + 1;
  },
});

console.log(o.b); // Executa o getter, que retornar a + 1 (que  1)

Usando uma propriedade com nome computado

var expr = "foo";

var obj = {
  get [expr]() {
    return "bar";
  },
};

console.log(obj.foo); // "bar"

Smart / self-overwriting / lazy getters

Getters lhe do uma maneira de definir uma propriedade de um objeto, mas eles no calculam o valor da propriedade at que sejam acessados. Um getter adia o custo de clculo do valor at que o valor seja necessrio e, se nunca o for, voc no precisa pagar esse custo.

Uma tcnica de otimizao adicional para atrasar o clculo do valor de uma propriedade e cache-lo para acesso futuro so os smart ou memoized getters. O valor calculado na primeira vez que o getter invocado, sendo ento cacheado para que acessos subsequentes retornem o valor em cache sem recalcul-lo. Isso util nas seguintes situaes:

• Se o clculo da propriedade caro (usa muita RAM ou CPU, cria um worker, retorna um arquivo remoto, etc).
• Se o valor no necessrio agora. Ele ser utilizado depois ou, em alguns casos, nem mesmo o ser.
• Se for utilizado, ele ser acessado diversas vezes e no h necessidade de recalcular um valor que nunca ser alterado, ou no deveria ser recalculado.

Isso significa que voc no deveria utilizar um lazy getter para uma propriedade cujo valor voc espera mudar, porque o getter nunca ir recalcular o valor.

No exemplo a seguir, o objeto tem um getter como uma propriedade prpria (own property). Ao tentar obter essa propriedade que foi removida, ela ser readicionada, mas implicitamente como uma propriedade comum desta vez. Finalmente, o valor ser retornado.

get notifier() {
  delete this.notifier;
  return this.notifier = document.getElementById("bookmarked-notification-anchor");
},

Para o Firefox, veja tambm o cdigo do mdulo XPCOMUtils.jsm, que define a funo defineLazyGetter().

Especificaes

Compatibilidade com navegadores

Veja tambm

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