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

CKTIS / JavaScript

`Function.length` e aridade das funções

`fn.length` descreve a aridade esperada de uma função, enquanto `arguments.length` conta os argumentos passados numa chamada concreta.

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

Sintaxe

fn.length
Function.length
Function.prototype.length
fn.bind(thisArg, ...presetArgs).length
arguments.length

A aridade de uma função diz respeito ao seu número de parâmetros. Em JavaScript, fn.length é uma propriedade numérica que descreve a aridade esperada, não um método nem um requisito da chamada. O construtor incorporado tem Function.length igual a 1; o objeto invocável Function.prototype tem length igual a 0.

Numa função definida no código-fonte, contam-se os parâmetros da esquerda para a direita até ao primeiro com um valor predefinido para o parâmetro inteiro, sem contar esse parâmetro nem os seguintes. Um parâmetro rest como ...tail nunca conta. Um padrão de desestruturação conta como um só parâmetro: o valor predefinido interno em { x = 0 } não interrompe a contagem, mas o = {} externo em { x = 0 } = {} interrompe-a.

Numa função comum, arguments.length conta os argumentos efetivamente passados nessa chamada, incluindo um undefined explícito. As funções de seta não têm o seu próprio arguments; se (...args) for a lista de parâmetros completa, args.length conta todos os argumentos. A seguir aos parâmetros com nome, o array do parâmetro rest contém apenas os argumentos restantes.

Se a função tiver uma propriedade própria length inalterada com um valor inteiro finito, bind subtrai o número de argumentos pré-fixados, sem descer abaixo de zero. thisArg não conta. A propriedade length inicial não permite escrita nem é enumerável, mas é configurável. Não a uses para validar chamadas: JavaScript permite passar um número diferente de argumentos e o resultado depende da função.

Exemplos

{
  function inspect({ x = 0 }, y = 10, z, ...tail) {
    return `${arguments.length}:${tail.length}`;
  }

  console.log(inspect.length);
  console.log(inspect.bind(null, {}).length);
  console.log(inspect({}));
  console.log(inspect({}, undefined, 3, 4, 5));
  console.log(Function.length);
  console.log(Function.prototype.length);
}

Resultado

1
0
1:0
5:2
1
0

`inspect.length` vale `1` porque só conta `{ x = 0 }`. Fixar `{}` como argumento de antemão reduz o valor para `0`. Em `1:0` e `5:2`, o primeiro número conta todos os argumentos passados e o segundo apenas os elementos de `tail`. O `undefined` explícito conta como argumento, embora faça com que `y` assuma o valor predefinido.

Lições relacionadas

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

Fontes