JavaScript tutorial:
length property (Function)

 

Applies to: Function Object

The length porperty is use to get the number of arguments defined for a function.

Syntax

functionname.length

The functionname argument is required and is the name of the function in question.

Return

Returns the number of arguments defined for a function.

Example

The length property of a function is initialized by the scripting engine to the number of arguments in the function's definition when an instance of the function is created.

What happens when a function is called with a number of arguments different from the value of its length property depends on the function.

The following example illustrates the use of the length property:

function ArgTest(a, b)
{
var i, s = "The ArgTest function expected ";
var numargs = ArgTest.arguments.length;
var expargs = ArgTest.length;
if (expargs < 2)
s += expargs + " argument. ";
else
s += expargs + " arguments. ";
if (numargs < 2)
s += numargs + " was passed.";
else
s += numargs + " were passed.";
return(s);
}
document.write(ArgTest(79, 81, 12, "Henry"));

  To run the code above, paste it into JavaScript Editor, and click the Execute button

See also: arguments Property, length Property (Array), length Property (String)