How best to determine if an argument is not sent to the JavaScript function

by

There are several different ways to check if an argument was passed to a function. In addition to the two you mentioned in your (original) question – checking arguments.length or using the || operator to provide default values – one can also explicitly check the arguments for undefined via argument2 === undefined or typeof argument2 === 'undefined' if one is paranoid (see comments).

Using the || operator has become standard practice – all the cool kids do it – but be careful: The default value will be triggered if the argument evaluates to false, which means it might actually be undefined, null, false, 0, '' (or anything else for which Boolean(...) returns false).

So the question is when to use which check, as they all yield slightly different results.

Checking arguments.length exhibits the ‘most correct’ behaviour, but it might not be feasible if there’s more than one optional argument.

The test for undefined is next ‘best’ – it only ‘fails’ if the function is explicitly called with an undefined value, which in all likelyhood should be treated the same way as omitting the argument.

The use of the || operator might trigger usage of the default value even if a valid argument is provided. On the other hand, its behaviour might actually be desired.

To summarize: Only use it if you know what you’re doing!

In my opinion, using || is also the way to go if there’s more than one optional argument and one doesn’t want to pass an object literal as a workaround for named parameters.

Another nice way to provide default values using arguments.length is possible by falling through the labels of a switch statement:

function test(requiredArg, optionalArg1, optionalArg2, optionalArg3) {
    switch(arguments.length) {
        case 1: optionalArg1 = 'default1';
        case 2: optionalArg2 = 'default2';
        case 3: optionalArg3 = 'default3';
        case 4: break;
        default: throw new Error('illegal argument count')
    }
    // do stuff
}

This has the downside that the programmer’s intention is not (visually) obvious and uses ‘magic numbers’; it is therefore possibly error prone.

More Related Contents:

  1. How to receive and maintain values in functions (javascript)
  2. How do I pass command line arguments to a Node.js program?
  3. Set a default parameter value for a JavaScript function
  4. JavaScript variable number of arguments to function
  5. Is there a better way to do optional function parameters in JavaScript? [duplicate]
  6. What is “undefined x 1” in JavaScript?
  7. How can I convert the “arguments” object to an array in JavaScript?
  8. ES6 destructuring function parameter – naming root object
  9. jQuery pass more parameters into callback
  10. Is it possible to get all arguments of a function as single object inside that function?
  11. JavaScript: Get Argument Value and NAME of Passed Variable [duplicate]
  12. Why do arrow functions not have the arguments array? [duplicate]
  13. What happens if I call a JS method with more parameters than it is defined to accept?
  14. Call function with array of arguments
  15. Converting an array to a function arguments list [duplicate]
  16. Inspect the names/values of arguments in the definition/execution of a JavaScript function
  17. Multiple arguments vs. options object
  18. What happens if I call a function with more arguments than it is defined to accept?
  19. Passing a function with arguments as an argument?
  20. Pass only the second argument in javascript
  21. What is difference between width, innerWidth and outerWidth, height, innerHeight and outerHeight in jQuery
  22. Why the onclick element will trigger twice for label element
  23. Slowdown due to non-parallel awaiting of promises in async generators
  24. How can I get city name from a latitude and longitude point?
  25. Creating and appending detached elements with d3.create
  26. Multiple Select limit number of selection
  27. Flex items not shrinking when window gets smaller [duplicate]
  28. Dynamic deep setting for a JavaScript object [duplicate]
  29. Using a Set data structure in React’s state
  30. Can I intercept a function called directly?

Leave a Comment