用于指示函数参数的标准约定在 JavaScript 中没有使用

有没有什么标准方法可以将函数参数标记为 JavaScript 中未使用的,类似于在 Ruby 中使用下划线开始方法参数?

46894 次浏览

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 and you're using this (which jQuery also sets to the value) for something else:

$.each(objectOrArrayLikeThing, (_, value) => {
// Use `value` here
});

(Yes, $.each passes arguments to the callback backward compared to the JavaScript standard forEach.)

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));

Using destructuring assignment, one can do:

function f(...[, , third]) {
console.log(third);
}


f(1, 2, 3);

Another approach: For unused parameters to be ignore from unused errors using:

function(_1, _2, toBeUseParam) { ... }