Me gustaría usar async / await con algunas operaciones del sistema de archivos. Normalmente async / await funciona bien porque lo uso babel-plugin-syntax-async-functions.

Pero con este código me encuentro con el caso if donde namesno está definido:

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

Cuando reconstruyo el código en la versión de devolución de llamada todo está bien y obtengo los nombres de archivo. Gracias por tus sugerencias.

Comenzando con el nodo 8.0.0, puede usar esto:

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

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

El soporte nativo para asíncrono espera funciones fs desde el Nodo 11

Desde Node.JS 11.0.0 (estable) y la versión 10.0.0 (experimental), tiene acceso a los métodos del sistema de archivos que ya están prometidos y puede usarlos con try catchmanejo de excepciones en lugar de verificar si el valor devuelto de la devolución de llamada contiene un error.

¡La API es muy limpia y elegante! Simplemente use.promises miembro del fsobjeto:

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

Asíncrono nativo / espera

Promisificar

Desde esta versión, puede usar la función nativa Node.js de la biblioteca 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()

Envoltura de promesas

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

Consejo

Utilice siempre try..catchpara bloques de espera, si no desea volver a lanzar la excepción superior.

Puede producir un comportamiento incorrecto porque File-Api fs.readdirno devuelve una promesa. Solo toma una devolución de llamada. Si desea utilizar la sintaxis de espera asíncrona, puede 'prometer' la función de esta manera:

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

y llámalo en su lugar:

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

A partir de v10.0 , puede usarfs.Promises

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

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

Esta es la versión de TypeScript a la pregunta. Es utilizable después del Nodo 11.0:

import { promises as fs } from 'fs';

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

Esto es lo que funcionó para mí:

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

Este código funciona en el nodo 7.6 sin babel cuando la bandera de la armonía está activada: node --harmony my-script.js. Y comenzando con el nodo 7.7, ¡ni siquiera necesita esta bandera !

La fspbiblioteca incluida al principio es solo un contenedor prometido para fs(y fs-ext).

¡Estoy realmente entusiasmado con lo que puedes hacer en el nodo sin babel en estos días! ¡Native async/ awaithacer que escribir código sea un placer!

ACTUALIZACIÓN 2017-06: el módulo fs-promise fue obsoleto. Utilice en su fs-extralugar con la misma API.

Se recomienda utilizar un paquete npm como https://github.com/davetemplin/async-file , en comparación con las funciones personalizadas. Por ejemplo:

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

Otras respuestas están desactualizadas

Tengo este pequeño módulo de ayuda que exporta versiones de funciones prometidasfs

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

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

Nodo v14.0.0 y superior

solo puedes hacer:

import { readdir } from "fs/promises";

tal como importarías de "fs"

vea este PR para más detalles: https://github.com/nodejs/node/pull/31553