CODEWITHSUNDEEP
javascriptparameter-passing
tobylaroni
tobylaroni

Reputation: 863

Approach to passing named arguments to a JavaScript Function. Any problems?

This is related to, but in my mind not a duplicate of, Passing named arguments to a Javascript function [duplicate] and Named parameters in javascript.

Various answers and comments on those questions propose approaches to deal with the lack of JavaScript language support for named arguments.

The original poster's concern was this:

Calling a Javascript function with something like

someFunction(1, true, 'foo');

is not very clear without familiarity with the function.

Let's say someFunction is declared elsewhere in the code as:

function someFunction(numberOfClowns,wearingHat,screamingAtTopOfLungs) {
    console.log(arguments)
}

Is there any particular reason why you couldn't call the function like this?

someFunction(numberOfClowns=1, wearingHat=true,screamingAtTopOfLungs='foo')

From my preliminary testing, this seems to not result in any errors, and certainly addresses any issues of clarity.

I guess you would need to var all of the variables beforehand, and be aware that variable assignment is occurring, so not be too surprised that numberOfClowns is now equal to 1. Anything else that I'm not considering?

Upvotes: 2

Views: 81

Answers (3)

Bergi
Bergi

Reputation: 664406

I guess you would need to var all of the variables beforehand, and be aware that variable assignment is occurring

This is a major problem in my eyes. It makes this a whole more complicated than any of the other approaches, and it's not a local solution - you're polluting your scope.

Anything else that I'm not considering?

The main argument of named parameters/named arguments is that you can order and omit them however you want, and the right values will still end up in the right variables. Your approach does not provide this. Better just use objects as everyone does.

I'd wager there will be more problems than without the assignments.

Upvotes: 3

Oriol
Oriol

Reputation: 288100

As you say, assignments return the assigned value, so if the variables are properly declared, there is no problem. To avoid conflicts with other code in the same function, I suggest wrapping the call inside a block, and declaring the parameters with let.

function someFunction(numberOfClowns, wearingHat, screamingAtTopOfLungs) {
  console.log(numberOfClowns, wearingHat, screamingAtTopOfLungs);
}
{
  let numberOfClowns, wearingHat, screamingAtTopOfLungs;
  someFunction(numberOfClowns=1, wearingHat=true, screamingAtTopOfLungs='foo');
}

You may also be interested in destructuring objects:

function someFunction({numberOfClowns, wearingHat, screamingAtTopOfLungs}) {
  console.log(numberOfClowns, wearingHat, screamingAtTopOfLungs);
}
someFunction({numberOfClowns: 1, wearingHat: true, screamingAtTopOfLungs: 'foo'});

Upvotes: 1

DaoWen
DaoWen

Reputation: 33019

Since you're just using the assignments as labels anyway, why not simply use comments?

someFunction(/*numberOfClowns=*/1,  /*wearingHat=*/true, /*screamingAtTopOfLungs=*/'foo')

I've seen this done in C code (particularly for functions with 5 or more arguments), and it would avoid the nasty side-effects you mention.

Since there aren't actually any checks being done with the var-assignment version, this seems to have all the same benefits without the downsides.

Upvotes: 4

Related Questions