Chciałbym używać async / await z niektórymi operacjami na systemie plików. Zwykle async / await działa dobrze, ponieważ używam babel-plugin-syntax-async-functions.

Ale z tym kodem napotykam przypadek if, w którym namesjest niezdefiniowany:

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

Kiedy przebudowuję kod na wersję callback hell, wszystko jest w porządku i otrzymuję nazwy plików. Dzięki za podpowiedzi.

Począwszy od węzła 8.0.0, możesz użyć tego:

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

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

Natywne wsparcie dla funkcji async await fs od Node 11

Od wersji Node.JS 11.0.0 (stabilna) i 10.0.0 (eksperymentalna) masz dostęp do metod systemu plików, które są już obiecane i możesz ich używać z try catchobsługą wyjątków zamiast sprawdzać, czy zwrócona wartość wywołania zwrotnego zawiera błąd.

Interfejs API jest bardzo czysty i elegancki! Po prostu użyj .promisesczłonka fsobiektu:

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

Natywny async / await

Promisify

Od tej wersji można używać natywnej funkcji Node.js z biblioteki 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()

Pakowanie obietnic

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

Rada

Zawsze używaj try..catchdla bloków await, jeśli nie chcesz ponownie wyrzucać wyjątku górnego.

Możesz uzyskać niewłaściwe zachowanie, ponieważ File-Api fs.readdirnie zwraca obietnicy. Wystarczy oddzwonić. Jeśli chcesz korzystać ze składni async-await, możesz `` obiecać '' funkcję w następujący sposób:

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

i nazwij to zamiast tego:

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

Od wersji 10.0 możesz używaćfs.Promises

Przykład użycia 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();

Przykład użycia 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);
})();

To jest wersja TypeScript pytania. Można go używać po Węzeł 11.0:

import { promises as fs } from 'fs';

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

Oto, co zadziałało dla mnie:

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

Ten kod działa w węźle 7.6 bez babel gdy flaga harmonia jest włączona: node --harmony my-script.js. Począwszy od węzła 7.7, nie potrzebujesz nawet tej flagi !

fspBiblioteka zawarte na początku jest tylko promisified wrapper dla fs(i fs-ext).

Jestem naprawdę podekscytowany tym, co możesz teraz zrobić w Node bez Babel! Native async/ awaitsprawiają, że pisanie kodu to taka przyjemność!

UPDATE 2017-06: moduł fs-promise został wycofany. fs-extraZamiast tego użyj tego samego interfejsu API.

Zaleca się używanie pakietu npm, takiego jak https://github.com/davetemplin/async-file , w porównaniu z funkcjami niestandardowymi. Na przykład:

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

Inne odpowiedzi są nieaktualne

Mam ten mały moduł pomocniczy, który eksportuje obiecane wersje fsfunkcji

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

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

Węzeł 14.0.0 i nowsze

możesz po prostu zrobić:

import { readdir } from "fs/promises";

tak jak importujesz z "fs"

zobacz ten PR, aby uzyskać więcej informacji: https://github.com/nodejs/node/pull/31553