What is the arguments object?

This page is not actively maintained and may be outdated. Please refer to MDN's arguments page instead.

Original contents

The arguments object is a special construct available inside all function calls. It represents the list of arguments that were passed in when invoking the function. Since JavaScript allows functions to be called with any number args, we need a way to dynamically discover and access them.

The arguments object is an array-like object. It has a length property that corresponds to the number of arguments passed into the function. You can access these values by indexing into the array, e.g. arguments[0] is the first argument. The only other property of arguments is callee, which ES5 forbids to use in strict mode more about it could be found here. Here's an example that illustrates the properties of arguments.

const myfunc = function (one) {
  arguments[0] === one;
  arguments[1] === 2;
  arguments.length === 3;

myfunc(1, 2, 3);

This construct is very useful and gives JavaScript functions a lot of flexibility. But there is an important gotcha. The arguments object behaves like an array, but it is not an actual array. It does not have Array in its prototype chain and it does not respond to any array methods, e.g. arguments.sort() raises a TypeError. Instead, you need to copy the values into a true array first. With the advent of ES6 Array.from() method this is quite straightforward.

const myfunc = function (a, b, c) {
  const args = Array.from(arguments);
  console.log(args); // [1, 2, 3]

myfunc(1, 2, 3);

NOTE: For ES5 and below, a normal for loop can do the trick.

In certain cases you can still treat arguments as an array. You can use arguments in dynamic function invocations using apply. And most native Array methods will also accept arguments when dynamically invoked using call or apply. This technique also suggests another way to convert arguments into a true array using the Array.slice method.

// turn arguments into a true array
const args = Array.prototype.slice.call(arguments);

Arguments object in arrow function

The arrow functions were added in the ECMAScript 2015 (ES6) specification as a syntactically compact alternative to a regular function expression. A drawback to this new alternative is the lack of arguments object (and this, super, and new.target keywords). A workaround for such cases is the use of rest parameter. The rest parameter allows you to represent an indefinite number of arguments as an array. For more details read here.

const myfunc = (...args) => {
  console.log('first parameter is ', args[0]);

myfunc(1, 2, 3);
Scroll to top