Eslint参考手册
规则 | Rules
handle-callback-err
在 Node.js 中,处理异步行为的常见模式称为回调模式。此模式需要一个Error
对象或null
作为回调的第一个参数。忘记处理这些错误可能会导致应用程序中出现一些非常奇怪的行为。
function loadData (err, data) {
doSomething(); // forgot to handle error
}
规则细节
这个规则期望当你在 Node.js 中使用回调模式时,你会处理这个错误。
选项
该规则采用单个字符串选项:错误参数的名称。默认是"err"
。
使用默认参数名称的此规则的代码不正确的示例"err"
:
/*eslint handle-callback-err: "error"*/
function loadData (err, data) {
doSomething();
}
具有默认参数名称的此规则的正确代码示例"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();
}
正则表达式
有时(特别是在大型项目中)错误变量的名称在项目中不一致,因此您需要更灵活的配置以确保规则报告所有未处理的错误。
如果错误变量的配置名称以 a 开头,^
则认为它是正则表达式模式。
- 如果选项是
"^(err|error|anySpecificError)$"
,则该规则会报告参数名称可能出现的未处理错误err
,error
或anySpecificError
。
- 如果选项是
"^.+Error$"
,则规则报告参数名以Error
(例如,connectionError
或validationError
将匹配)结尾的未处理的错误。
- 如果选择是
"^.*(e|E)rr"
,该规则报告,其中的参数名称中包含任何字符串匹配未处理的错误err
或Err
(例如err
,error
,anyError
,some_err
将匹配)。
何时不使用它
在某些情况下,您的应用程序可能会安全地忽略错误,但是如果您确信某种其他形式的监控可以帮助您解决问题,则只会忽略错误。
进一步阅读
- The Art Of Node: Callbacks
- Nodejitsu: What are the error conventions?
版本
该规则在 ESLint 0.4.5 中引入。
资源
- Rule source
- Documentation source
规则 | Rules相关
ESLint 是一个代码规范和错误检查工具,有以下几个特性。所有东西都是可以插拔的。你可以调用任意的 rule api 或者 formatter api 去打包或者定义 rule or formatter。任意的 rule 都是独立的。没有特定的 coding style,你可以自己配置。
主页 | https://eslint.org/ |
源码 | https://github.com/eslint/eslint |
发布版本 | 4.12.0 |