在node.js中使用带有async/await的文件系统

Question

我想在一些文件系统操作中使用async/await.通常async/await工作正常,因为我使用babel-plugin-syntax-async-functions.

但是使用这段代码,我遇到了names未定义的if情况:

import fs from 'fs';

async function myF() {
  let names;
  try {
    names = await fs.readdir('path/to/dir');
  } catch (e) {
    console.log('e', e);
  }
  if (names === undefined) {
    console.log('undefined');
  } else {
    console.log('First Name', names[0]);
  }
}

myF();

当我将代码重建到回调地狱版本时,一切正常,我得到了文件名.谢谢你的提示.

Answer 1

从节点8.0.0开始,您可以使用:

const fs = require('fs');
const util = require('util');

const readdir = util.promisify(fs.readdir);

async function myF() {
  let names;
  try {
    names = await readdir('path/to/dir');
  } catch (err) {
    console.log(err);
  }
  if (names === undefined) {
    console.log('undefined');
  } else {
    console.log('First Name', names[0]);
  }
}

myF();

请参阅https://nodejs.org/dist/latest-v8.x/docs/api/util.html#util_util_promisify_original

Answer 2

Node.js 8.0.0

原生异步/等待

const fs = require('fs')
const { promisify } = require('util')

const readFileAsync = promisify(fs.readFile)
const writeFileAsync = promisify(fs.writeFile)

const run = async () => {
  const res = await readFileAsync('./data.json')
  console.log(res)
}

run()

用法

try..catch如果您不想重新抛出异常上层,请始终用于等待块.

const fs = require('fs')

const readFile = (path, opts = 'utf8') =>
  new Promise((resolve, reject) => {
    fs.readFile(path, opts, (err, data) => {
      if (err) reject(err)
      else resolve(data)
    })
  })

const writeFile = (path, data, opts = 'utf8') =>
  new Promise((resolve, reject) => {
    fs.writeFile(path, data, opts, (err) => {
      if (err) reject(err)
      else resolve()
    })
  })

module.exports = {
  readFile,
  writeFile
}

...


// in some file, with imported functions above
// in async block
const run = async () => {
  const res = await readFile('./data.json')
  console.log(res)
}

run()

Answer 3

您可能会产生错误的行为,因为File-Api fs.readdir不会返回承诺.它只需要一个回调.如果你想使用async-await语法,你可以'promisify'这个函数:

function readdirAsync(path) {
  return new Promise(function (resolve, reject) {
    fs.readdir(path, function (error, result) {
      if (error) {
        reject(error);
      } else {
        resolve(result);
      }
    });
  });
}

并改为称之为:

names = await readdirAsync('path/to/dir');

Answer 4

自版本10以来,本机异步等待样式fs函数[实验]

从Node.JS 10.0.0开始,您可以访问已经实现的文件系统方法,并且可以将它们与try catch异常处理一起使用,而不是检查返回值是否包含错误.

API是实验性的,但它非常干净和优雅!只需使用对象.promises成员fs:

import fs from 'fs';
const fsPromises = fs.promises;

async function listDir() {
  try {
    return fsPromises.readdir('path/to/dir');
  } catch (err) {
    console.error('Error occured while reading directory!', err);
  }
}

listDir();

Answer 5

这是问题的 TypeScript 版本。它在 Node 11.0 之后可用：

import { promises as fs } from 'fs';

async function loadMonoCounter() {
    const data = await fs.readFile('monolitic.txt', 'binary');
    return Buffer.from(data);
}

Answer 6

You can use fs.Promises

const { promises: fs } = require("fs");

async function myF() {
    let names;
    try {
        names = await fs.readdir("path/to/dir");
    } catch (e) {
        console.log("e", e);
    }
    if (names === undefined) {
        console.log("undefined");
    } else {
        console.log("First Name", names[0]);
    }
}

myF();

Example using readFile

const { promises: fs } = require("fs");

async function getContent(filePath, encoding = "utf-8") {
    if (!filePath) {
        throw new Error("filePath required");
    }

    return fs.readFile(filePath, { encoding });
}

(async () => {
    const content = await getContent("./package.json");

    console.log(content);
})();

Answer 7

我有这个小帮助模块可以导出函数的promisified版本fs

const fs = require("fs");
const {promisify} = require("util")

module.exports = {
  readdir: promisify(fs.readdir),
  readFile: promisify(fs.readFile),
  writeFile: promisify(fs.writeFile)
  // etc...
};

Answer 8

Node v14.0.0 及以上

你可以这样做：

import { readdir } from "fs/promises";

就像你从 "fs"

有关更多详细信息，请参阅此 PR：https : //github.com/nodejs/node/pull/31553

Answer 9

这对我有用:

const fsp = require('fs-promise');

(async () => {
  try {
    const names = await fsp.readdir('path/to/dir');
    console.log(names[0]);
  } catch (e) {
    console.log('error: ', e);
  }
})();

当启用和声标志时,此代码在没有babel的节点7.6中工作:node --harmony my-script.js.从节点7.7开始,你甚至不需要这个标志!

fsp包含在开头的库只是fs(和fs-ext)的一个有保证的包装器.

这些天我真的已经离开了没有babel的节点你可以做什么!原生async/ await使编写代码非常愉快!

更新2017-06: fs-promise模块已弃用.请fs-extra改用相同的API.

Answer 10

与自定义函数相比，建议使用诸如https://github.com/davetemplin/async-file之类的npm软件包。例如：

import * as fs from 'async-file';

await fs.rename('/tmp/hello', '/tmp/world');
await fs.appendFile('message.txt', 'data to append');
await fs.access('/etc/passd', fs.constants.R_OK | fs.constants.W_OK);

var stats = await fs.stat('/tmp/hello', '/tmp/world');

其他答案已过时