在TypeScript项目里怎样实现NodeJS fs模块与ESM导出的兼容

在TypeScript项目开发中，常常会遇到需要使用NodeJS的fs模块，同时又希望采用ESM（ECMAScript Modules）导出方式的情况。然而，这两者之间的兼容并非一帆风顺，需要我们掌握一些技巧来实现无缝对接。

要理解NodeJS的fs模块默认是采用CommonJS规范的。而ESM是JavaScript的标准模块系统，有着不同的语法和规则。在TypeScript项目里，要开启对ESM的支持，需要在package.json文件中设置"type": "module"，这会让NodeJS将.js文件都当作ESM模块来处理。

对于fs模块的引入，在ESM环境下不能再使用传统的const fs = require('fs')方式。正确的做法是使用import fs from 'fs'。但这里会遇到一个问题，TypeScript默认情况下无法识别这种导入方式，因为它与CommonJS的类型定义有所不同。

为了解决类型问题，我们需要安装@types/node类型定义文件。安装完成后，在TypeScript文件顶部引入import fs from 'fs'时，TypeScript就能正确识别fs模块的类型了。

在进行文件操作时，fs模块提供了众多方法，如读取文件fs.readFile、写入文件fs.writeFile等。在ESM导出中，我们可以将这些操作封装在函数里，然后通过export语句导出。例如：

import fs from 'fs';

async function readMyFile() {
    return new Promise((resolve, reject) => {
        fs.readFile('example.txt', 'utf8', (err, data) => {
            if (err) {
                reject(err);
            } else {
                resolve(data);
            }
        });
    });
}

export { readMyFile };

在其他模块中就可以通过import { readMyFile } from './yourModule.js'来使用这个函数。

通过上述步骤，我们能够在TypeScript项目里实现NodeJS fs模块与ESM导出的兼容，既充分利用fs模块强大的文件操作能力，又遵循现代JavaScript的ESM规范，让项目的代码结构更加清晰和易于维护。