TypeScript 文件系统操作：实用指南

引言：为什么在 TypeScript 中需要文件系统操作

TypeScript 作为 JavaScript 的严格类型化超集，为开发者提供了强大的文件系统操作工具。无论您是在创建日志处理工具、带有文件上传功能的 Web 服务器，还是数据迁移工具——能够高效地与文件系统交互都是一项基本技能。

在本文中，我们将探讨如何在 TypeScript 中使用 Node.js 内置的 fs（File System）模块进行实际的文件系统操作。所有示例都将附带详细的注释和解释。我们将介绍同步和异步方法、路径操作以及数据类型的处理。

1. 项目设置与导入 fs 模块

在开始之前，需要配置 TypeScript 项目。请确保已安装 Node.js 和 npm 包管理器。创建一个新项目并安装 Node.js 的类型定义：

npm init -ynpm install typescript @types/node --save-devnpm install ts-node --save-dev

创建 tsconfig.json 文件并添加基本配置：

{  "compilerOptions": {    "target": "ES2020",    "module": "commonjs",    "strict": true,    "esModuleInterop": true,    "outDir": "./dist",    "rootDir": "./src"  },  "include": ["src/**/*"]}

现在，在您的 index.ts 文件中导入 fs 和 path 模块：

import * as fs from 'fs';import * as path from 'path';

重要提示： 在 TypeScript 中，我们使用 import * as 来导入整个模块。这可以确保所有方法都具有完整的类型定义。

2. 文件读取：同步与异步方法

2.1 异步读取（推荐方式）

在 TypeScript 中，推荐使用异步方法，因为它们不会阻塞主执行线程。以下是一个读取文本文件的示例：

import * as fs from 'fs/promises';import * as path from 'path';

async function readFileExample(filePath: string): Promise<string> {  try {    const absolutePath = path.resolve(filePath);    const content: string = await fs.readFile(absolutePath, 'utf-8');    return content;  } catch (error) {    if (error instanceof Error) {      throw new Error(`文件读取错误: ${error.message}`);    }    throw error;  }}

// 使用示例(async () => {  const data = await readFileExample('./data/example.txt');  console.log('文件内容:', data);})();

请注意使用了 fs/promises——这是带有 Promise 的模块版本，能够很好地与 TypeScript 中的 async/await 集成。

2.2 同步读取（适用于简单场景）

有时，例如在启动时加载配置文件，可以使用同步方法：

import * as fs from 'fs';import * as path from 'path';

function readConfigSync(configPath: string): Record<string, unknown> {  const fullPath = path.join(__dirname, configPath);  const rawData = fs.readFileSync(fullPath, 'utf-8');  return JSON.parse(rawData);}

const config = readConfigSync('./config.json');console.log('配置:', config);

3. 文件写入与修改

3.1 将数据写入文件

使用 writeFile 将数据写入文件。TypeScript 允许在写入前对数据进行严格的类型定义：

import * as fs from 'fs/promises';

interface UserData {  id: number;  name: string;  email: string;}

async function saveUserData(users: UserData[]): Promise<void> {  const jsonString: string = JSON.stringify(users, null, 2);  await fs.writeFile('./users.json', jsonString, 'utf-8');  con