handle-callback-err

在回调中要求错误处理

在 Node.js 中，处理异步行为的常见模式称为回调模式。此模式期望一个 Error 对象或 null 作为回调的第一个参数。忘记处理这些错误可能会导致应用程序中出现一些非常奇怪的行为。

function loadData (err, data) {
    doSomething(); // forgot to handle error
}
1
2
3

规则详情

此规则期望当您在 Node.js 中使用回调模式时，您将处理错误。

选项

该规则接受一个字符串选项：错误参数的名称。默认值为 "err"。

对于此规则，使用默认 "err" 参数名称的不正确代码示例

/*eslint handle-callback-err: "error"*/

function loadData (err, data) {
    doSomething();
}

1
2
3
4
5
6

对于此规则，使用默认 "err" 参数名称的正确代码示例

/*eslint handle-callback-err: "error"*/

function loadData (err, data) {
    if (err) {
        console.log(err.stack);
    }
    doSomething();
}

function generateError (err) {
    if (err) {}
}
1
2
3
4
5
6
7
8
9
10
11
12

对于此规则，使用示例 "error" 参数名称的正确代码示例

/*eslint handle-callback-err: ["error", "error"]*/

function loadData (error, data) {
    if (error) {
       console.log(error.stack);
    }
    doSomething();
}
1
2
3
4
5
6
7
8

正则表达式

有时（尤其是在大型项目中），错误变量的名称在整个项目中不一致，因此您需要更灵活的配置来确保该规则报告所有未处理的错误。

如果错误变量的配置名称以 ^ 开头，则认为它是正则表达式模式。

• 如果选项是 "^(err|error|anySpecificError)$"，则当参数名称可以是 err、error 或 anySpecificError 时，该规则会报告未处理的错误。
• 如果选项是 "^.+Error$"，则该规则会报告参数名称以 Error 结尾的未处理错误（例如，connectionError 或 validationError 将匹配）。
• 如果选项是 "^.*(e|E)rr"，则该规则会报告参数名称与包含 err 或 Err 的任何字符串匹配的未处理错误（例如，err、error、anyError、some_err 将匹配）。

何时不使用它

在某些情况下，您的应用程序忽略错误可能是安全的，但是，只有当您确信某些其他形式的监控将帮助您捕获问题时，才应忽略错误。

版本

此规则在 ESLint v0.4.5 中引入。

延伸阅读

GitHub - maxogden/art-of-node: node.js 简短介绍
github.com

什么是错误约定？ - docs.nodejitsu.com
web.archive.org

资源

• 规则来源
• 测试来源