Eslint
规则 | Rules

callback-return

回拨之后强制回车(回叫)

回调模式是 JavaScript 中大多数 I / O 和事件驱动编程的核心。

function doSomething(err, callback) { if (err) { return callback(err } callback( }

为了防止多次调用回调,return任何时候在主函数体外触发回调都很重要。忽视这种技术通常会导致你不止一次地做某事的问题。例如,对于 HTTP 请求,您可能会尝试多次发送HTTP标头,引导 Node.js为 throwCan't render headers after they are sent to the client.错误。

规则细节

规则旨在确保在主功能块外部使用的回调始终是在return语句之前的部分或之前。该规则根据被调用函数的名称决定什么是回调。

选项

规则采用单个选项 - 可能的回调名称数组 - 可能包含对象方法。默认的回调名称callbackcbnext

默认回调名称

["callback", "cb", "next"]规则的默认错误代码示例:

/*eslint callback-return: "error"*/ function foo(err, callback) { if (err) { callback(err } callback( }

具有默认选项的["callback", "cb", "next"]规则的正确代码示例:

/*eslint callback-return: "error"*/ function foo(err, callback) { if (err) { return callback(err } callback( }

提供回调名称

["done", "send.error", "send.success"]规则的错误代码示例包含以下选项:

/*eslint callback-return: ["error", ["done", "send.error", "send.success"]]*/ function foo(err, done) { if (err) { done(err } done( } function bar(err, send) { if (err) { send.error(err } send.success( }

["done", "send.error", "send.success"]规则的正确代码示例包含以下选项:

/*eslint callback-return: ["error", ["done", "send.error", "send.success"]]*/ function foo(err, done) { if (err) { return done(err } done( } function bar(err, send) { if (err) { return send.error(err } send.success( }

已知限制

由于通过静态分析难以理解程序的含义,因此该规则具有局限性:

  • 假负数时,规则报告正确的代码,但程序会调用回调超过一次(这是不正确的行为)

  • 当此规则报告不正确的代码时误报,但程序只调用一次回调(这是正确的行为)

通过引用传递回调

如果规则是函数的参数(例如,setTimeout),则规则的静态分析不会检测到程序调用回调。

规则报告正确的代码时出现错误否定的示例:

/*eslint callback-return: "error"*/ function foo(err, callback) { if (err) { setTimeout(callback, 0 // this is bad, but WILL NOT warn } callback( }

触发嵌套函数中的回调

规则的静态分析未检测到程序从嵌套函数或立即调用的函数表达式(IIFE)中调用回调。

此规则报告正确的代码时出现错误否定的示例:

/*eslint callback-return: "error"*/ function foo(err, callback) { if (err) { process.nextTick(function() { return callback( // this is bad, but WILL NOT warn } } callback( }

If / else语句

规则的静态分析未检测到程序仅在if语句的每个分支中调用一次回调。

此规则报告不正确的代码时出现误报示例:

/*eslint callback-return: "error"*/ function foo(err, callback) { if (err) { callback(err // this is fine, but WILL warn } else { callback( // this is fine, but WILL warn } }

何时不使用它

有些情况下您可能需要多次调用回调函数。在这些情况下,这个规则可能导致不正确的行为。在这些情况下,您可能需要为这些回调保留一个特殊名称,而不是将其包含在触发警告的回调列表中。

进一步阅读

相关规则

  • handle-callback-errVersion这个规则是在ESLint 1.0.0-rc-1.Resources中引入的