Multiple arguments vs. options object

by

Like many of the others, I often prefer passing an options object to a function instead of passing a long list of parameters, but it really depends on the exact context.

I use code readability as the litmus test.

For instance, if I have this function call:

checkStringLength(inputStr, 10);

I think that code is quite readable the way it is and passing individual parameters is just fine.

On the other hand, there are functions with calls like this:

initiateTransferProtocol("http", false, 150, 90, null, true, 18);

Completely unreadable unless you do some research. On the other hand, this code reads well:

initiateTransferProtocol({
  "protocol": "http",
  "sync":      false,
  "delayBetweenRetries": 150,
  "randomVarianceBetweenRetries": 90,
  "retryCallback": null,
  "log": true,
  "maxRetries": 18
 });

It is more of an art than a science, but if I had to name rules of thumb:

Use an options parameter if:

  • You have more than four parameters
  • Any of the parameters are optional
  • You’ve ever had to look up the function to figure out what parameters it takes
  • If someone ever tries to strangle you while screaming “ARRRRRG!”

More Related Contents:

  1. How do I use ‘this” keyword in an object literal? [closed]
  2. How to receive and maintain values in functions (javascript)
  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. How to add an object to an array
  7. Parse JSON String into a Particular Object Prototype in JavaScript
  8. Sum JavaScript object propertyA values with the same object propertyB in an array of objects
  9. ES6 destructuring function parameter – naming root object
  10. `new function()` with lower case “f” in JavaScript
  11. Which characters are valid/invalid in a JSON key name?
  12. jQuery pass more parameters into callback
  13. Adding custom properties to a function
  14. Convert object string to JSON
  15. How to get object length [duplicate]
  16. Sorting a JSON object in Javascript
  17. Is it possible to get all arguments of a function as single object inside that function?
  18. Merge keys array and values array into an object in JavaScript
  19. javascript : function and object…?
  20. Why in JavaScript both “Object instanceof Function” and “Function instanceof Object” return true?
  21. JSON.stringify function
  22. What happens if I call a JS method with more parameters than it is defined to accept?
  23. Reverse of JSON.stringify?
  24. How to write data to a JSON file using Javascript
  25. Encoding Javascript Object to Json string
  26. traversing through JSON string to inner levels using recursive function
  27. Is there any possibility to have JSON.stringify preserve functions?
  28. Javascript: stringify object (including members of type function)
  29. Get values from an object in JavaScript [duplicate]
  30. Pass only the second argument in javascript

Leave a Comment