Standard conventions for indicating a function argument is unused in JavaScript

牧云@^-^@ 提交于 2019-11-27 05:14:19

Just so we have an example to work from, this is fairly common with jQuery's $.each where you're writing code that doesn't need the index, just the value, in the iteration callback ($.each is backward relative to Array#forEach):

$.each(objectOrArrayLikeThing, function(_, value) { }
    // Use value here
});

Using _ is the closest I've seen to a standard way to do that, yes, but I've also seen lots of others — giving it a name reflective of its purpose anyway (index), calling it unused, etc.

If you need to ignore more than one parameter, you can't repeat the same identifier (it's disallowed in strict mode, which should be everyone's default and is the default in modules and class constructs), so you have do things like _0 and _1 or _ and __, etc.

With browsers supporting destructuring one can do:

function ({}, {}, value) {
  // console.log(value)
}

Which is kind of neat in that it avoids the problem of multiple arguments having the same name and also won't create problems with libraries that assign methods to _ (lodash, underscore, etc.).

One problem with this approach is that unused arguments of type undefined or null will throw.

For undefined one solution is to use default parameters:

function ({}={}, {}={}, value) {
  // console.log(value)
}

Sadly no such easily applied solution for null.

I would recommend this syntax:

function(_index, value) {...}

to not to shadow lodash variable and still have description of argument in case if it will be used.

VS Code is also highlight these names properly and these unused args won't be deleted after autofix code smells

How about using the function arguments object?

function third() { const [,,thirdArg] = arguments;
  return thirdArg;
}
console.log(third(1,2,3));
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!