no-sync

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

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

何时不使用

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