handle-callback-err
要求在回调中进行错误处理
此规则在 ESLint v7.0.0 中已 **弃用**。请在 eslint-plugin-n
中使用相应的规则。
在 Node.js 中,处理异步行为的一种常见模式称为回调模式。此模式期望将 Error
对象或 null
作为回调的第一个参数。忘记处理这些错误可能导致应用程序出现一些非常奇怪的行为。
function loadData (err, data) {
doSomething(); // forgot to handle error
}
规则详细信息
此规则期望在您在 Node.js 中使用回调模式时处理错误。
选项
该规则采用单个字符串选项:错误参数的名称。默认为 "err"
。
使用默认 "err"
参数名称的此规则的 **错误** 代码示例
在游乐场中打开
/*eslint handle-callback-err: "error"*/
使用默认 "err"
参数名称的此规则的 **正确** 代码示例
在游乐场中打开
/*eslint handle-callback-err: "error"*/
function loadData (err, data) {
if (err) {
console.log(err.stack);
}
doSomething();
}
function generateError (err) {
if (err) {}
}
使用示例 "error"
参数名称的此规则的 **正确** 代码示例
在游乐场中打开
/*eslint handle-callback-err: ["error", "error"]*/
function loadData (error, data) {
if (error) {
console.log(error.stack);
}
doSomething();
}
正则表达式
有时(尤其是在大型项目中),错误变量的名称在整个项目中并不一致,因此您需要更灵活的配置以确保规则报告所有未处理的错误。
如果错误变量的配置名称以 ^
开头,则将其视为正则表达式模式。
- 如果选项为
"^(err|error|anySpecificError)$"
,则规则将报告参数名称可以是err
、error
或anySpecificError
的未处理错误。 - 如果选项为
"^.+Error$"
,则规则将报告参数名称以Error
结尾的未处理错误(例如,connectionError
或validationError
将匹配)。 - 如果选项为
"^.*(e|E)rr"
,则规则将报告参数名称与包含err
或Err
的任何字符串匹配的未处理错误(例如,err
、error
、anyError
、some_err
将匹配)。
何时不使用它
在某些情况下,您的应用程序可能可以安全地忽略错误,但是只有在您确信某些其他形式的监控将帮助您捕获问题时,才能忽略错误。
版本
此规则是在 ESLint v0.4.5 中引入的。