# handle-callback-err

此规则在 ESLint v7.0.0 中已弃用。请使用 eslint-plugin-node 中的相应规则。

在 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();
}

# regular expression

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

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

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

# 何时不使用

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

← global-require id-blacklist →