javascript - 使用带有可选参数的回调

Question

我见过库在编写函数时利用可选参数和回调。我正在编写一个库，我想知道允许用户跳过可选参数并只发送回调是否是一个好习惯。

例如:

function listFiles(params, callback) {
  if (typeof params === 'function' && !callback) {
    callback = params;
    params = {};
  }
  // more code here...
}

我的库的用户可以使用参数调用 listFiles():

listFiles({ verbose: true }, function callback(err, results) { /*... */ })

或者只传递 callback() 函数:

listFiles(function callback(err, results) { /*... */ })

我看到这种方法的主要好处是用户不必做:

listFiles(null, function callback(err, results) { /*... */ })

或

listFiles({}, function callback(err, results) { /*... */ })

问题是，如果我将 verbose 作为必需的参数，我将打破没有发送 params 的用户以及发送空或 null 作为 参数。

我应该使用可选参数作为回调还是一个坏主意？

Answer 1

为什么不将 callback 作为参数之一，以便用户始终将单个参数传递给 listFiles()？

function listFiles(params) {
    // ... check for optional params and do something with them
    params.callback(err, result);
}

现在作为用户，我可以根据需要传递可选参数(使用 limit 和 sort 作为示例):

listFiles({
    limit: 10,
    sort: 'desc',
    callback: (err, result) => {
        // ... do something with result
    }
});

或者如果我想让 listFiles() 为我提供默认值，则只需要 callback 参数:

listFiles({
    callback: (err, result) => {
        // ... do something with result
    }
});