Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

`Function.length` et arité des fonctions

`fn.length` indique l’arité attendue d’une fonction, tandis que `arguments.length` compte les arguments fournis lors d’un appel donné.

Version : ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

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

L’arité d’une fonction se rapporte à son nombre de paramètres. En JavaScript, fn.length est une propriété numérique qui décrit l’arité attendue, pas une méthode ni une condition de validité de l’appel. Le constructeur intégré lui-même a Function.length égal à 1, et l’objet appelable Function.prototype a length égal à 0.

Pour une fonction définie dans le code source, on compte les paramètres de gauche à droite jusqu’au premier doté d’une valeur par défaut pour le paramètre entier, sans compter celui-ci ni les suivants. Un paramètre du reste tel que ...tail ne compte jamais. Un motif de déstructuration compte pour un seul paramètre : la valeur par défaut interne dans { x = 0 } n’interrompt pas le comptage, contrairement au = {} externe dans { x = 0 } = {}.

Dans une fonction ordinaire, arguments.length compte les arguments effectivement fournis lors de l’appel, y compris un undefined explicite. Les fonctions fléchées n’ont pas leur propre arguments ; si leur liste de paramètres se résume à (...args), args.length compte tous leurs arguments. Après des paramètres nommés, le tableau du reste ne contient que les arguments restants.

Pour une fonction dont la propriété propre length est inchangée et vaut un entier fini, bind soustrait le nombre d’arguments liés à l’avance, sans descendre sous zéro. thisArg ne compte pas. La propriété length initiale n’est ni modifiable par affectation ni énumérable, mais elle est configurable. Ne l’utilisez pas pour valider un appel : JavaScript autorise un autre nombre d’arguments et le résultat dépend de la fonction.

Exemples

{
  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);
}

Résultat

1
0
1:0
5:2
1
0

`inspect.length` vaut `1` parce que seul `{ x = 0 }` compte. Lier `{}` à l’avance fait passer la valeur à `0`. Dans `1:0` et `5:2`, le premier nombre compte tous les arguments fournis et le second seulement les éléments dans `tail`. Le `undefined` explicite compte comme argument, même s’il déclenche la valeur par défaut de `y`.

Leçons associées

  • JavaScript · Leçon 21 · Avancé · Version : 4

Sources