Я хотел бы использовать async / await с некоторыми операциями файловой системы. Обычно async / await отлично работает, потому что я использую babel-plugin-syntax-async-functions.

Но с этим кодом я сталкиваюсь с случаем if, где namesundefined:

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

Когда я перестраиваю код в адскую версию обратного вызова, все в порядке, и я получаю имена файлов. Спасибо за подсказки.

Начиная с узла 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

Встроенная поддержка функций async await fs начиная с Node 11

Начиная с Node.JS 11.0.0 (стабильный) и версии 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();

Node.js 8.0.0

Собственный async / await

Promisify

В этой версии вы можете использовать встроенную функцию Node.js из библиотеки util .

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

Обещание упаковки

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

Совет

Всегда используйте try..catchдля блоков ожидания, если вы не хотите повторно генерировать исключение наверху.

Вы можете вызвать неправильное поведение, потому что File-Api fs.readdirне возвращает обещание. Требуется только обратный вызов. Если вы хотите использовать синтаксис async-await, вы можете «обещать» функцию следующим образом:

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');

Начиная с версии 10.0 , вы можете использоватьfs.Promises

Пример использования readdir

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

Пример использования 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);
})();

Это версия 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);
}

Вот что у меня сработало:

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

Этот код работает в узле 7.6 без Бабеля , когда флаг гармонии включен: node --harmony my-script.js. А начиная с узла 7.7 вам даже не нужен этот флаг !

fspБиблиотека включена в начале это просто promisified обертка для fs(а fs-ext).

Я действительно в восторге от того, что вы можете делать в node без Babel в наши дни! Нативный async/ awaitсделать написание кода таким удовольствием!

ОБНОВЛЕНИЕ 2017-06: модуль fs- prom устарел. fs-extraВместо этого используйте тот же API.

Рекомендуется использовать пакет npm, такой как https://github.com/davetemplin/async-file , по сравнению с пользовательскими функциями. Например:

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');

Другие ответы устарели

У меня есть небольшой вспомогательный модуль, который экспортирует обещанные версии fsфункций.

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

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

Node v14.0.0 и выше

вы можете просто сделать:

import { readdir } from "fs/promises";

так же, как вы бы импортировали из "fs"

см. этот PR для более подробной информации: https://github.com/nodejs/node/pull/31553