no-sync

禁用同步方法

在 Node.js 中，大多数 I/O 操作都是通过异步方法完成的。然而，异步方法通常也有同步版本。例如，fs.exists() 和 fs.existsSync()。在某些情况下，使用同步操作是可以的（例如，如果您像 ESLint 一样，正在编写命令行实用程序）。然而，在其他情况下，使用同步操作被认为是一种应该避免的不良实践。例如，如果您在 Node.js 上运行高流量的 Web 服务器，您应该仔细考虑是否要允许任何可能锁定服务器的同步操作。

规则详情

此规则旨在防止在 Node.js 中调用同步方法。它专门查找方法后缀 “Sync”（这是 Node.js 操作的约定）。

选项

此规则有一个可选的对象选项 { allowAtRootLevel: <boolean> }，它决定是否允许在文件的顶层，即在任何函数之外，使用同步方法。此选项默认为 false。

使用默认 { allowAtRootLevel: false } 选项时，此规则的 错误 代码示例

/*eslint no-sync: "error"*/

fs.existsSync(somePath);

function foo() {
  var contents = fs.readFileSync(somePath).toString();
}
1
2
3
4
5
6
7

使用默认 { allowAtRootLevel: false } 选项时，此规则的 正确 代码示例

/*eslint no-sync: "error"*/

obj.sync();

async(function() {
    // ...
});
1
2
3
4
5
6
7

使用 { allowAtRootLevel: true } 选项时，此规则的 错误 代码示例

/*eslint no-sync: ["error", { allowAtRootLevel: true }]*/

function foo() {
  var contents = fs.readFileSync(somePath).toString();
}

var bar = baz => fs.readFileSync(qux);
1
2
3
4
5
6
7

使用 { allowAtRootLevel: true } 选项时，此规则的 正确 代码示例

/*eslint no-sync: ["error", { allowAtRootLevel: true }]*/

fs.readFileSync(somePath).toString();
1
2
3

何时不使用

如果您想在脚本中允许同步操作，请不要启用此规则。

版本

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

资源

• 规则源码
• 测试源码