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();
}具有默认选项的此规则的正确代码示例{ allowAtRootLevel: false }：
/*eslint no-sync: "error"*/
obj.sync();
async(function() {
// ...
});带有选项的此规则的代码不正确的示例{ allowAtRootLevel: true }
/*eslint no-sync: ["error", { allowAtRootLevel: true }]*/
function foo() {
var contents = fs.readFileSync(somePath).toString();
}
var bar = baz => fs.readFileSync(qux);带有选项的此规则的正确代码示例{ allowAtRootLevel: true }
/*eslint no-sync: ["error", { allowAtRootLevel: true }]*/
fs.readFileSync(somePath).toString();何时不使用它
如果您想在脚本中允许同步操作，请不要启用此规则。
版本
该规则在 ESLint 0.0.9 中引入。
资源
本文档系腾讯云开发者社区成员共同维护，如有问题请联系 cloudcommunity@tencent.com
