TypeScript 文件系统操作：完整指南

轻松学习Python，无需理论负担。在浏览器中直接解决带自动检查的实践任务，无需安装任何东西。

TypeScript 文件系统操作入门

文件系统操作是开发服务器端应用程序、实用工具和命令行工具时的关键任务之一。TypeScript 作为 JavaScript 的超集，提供了 Node.js 所有与文件和目录交互的功能，同时增加了强类型支持，使代码更加可靠和可预测。

本文将详细介绍如何在 TypeScript 中操作文件系统：从基本的读写操作到流处理和异步处理等高级技术。所有示例都附带了可直接在项目中使用的完整代码。

在 TypeScript 中操作文件系统需要使用 Node.js 内置的 fs（file system）模块。它提供了同步和异步两种方法。在现代项目中，建议使用基于 Promise 的异步版本（fs.promises）以实现非阻塞执行。

1. 项目配置与模块导入

开始之前，请确保您的项目已配置好 Node.js 和 TypeScript。创建项目目录并初始化：

mkdir fs-typescript-tutorialcd fs-typescript-tutorialnpm init -ynpm install typescript @types/node --save-devnpx tsc --init

配置完成后，在 tsconfig.json 文件中确保 module 参数设置为 commonjs 或 ESNext，target 设置为 ES2020 或更高版本。

现在创建 index.ts 文件并导入所需模块：

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

// 或者使用 promises 版本import { promises as fsPromises } from 'fs';

path 模块同样重要：它提供了处理文件路径的工具函数，使代码具有跨平台兼容性（Windows vs Unix）。

2. 文件读写操作

2.1 读取文件

让我们来看基本的文件操作。首先从读取文件内容开始。使用 async/await 的异步方法是最现代、最便捷的方式。

import { promises as fs } from 'fs';

async function readFileExample(filePath: string): Promise<string> {  try {    const data = await fs.readFile(filePath, 'utf-8');    return data;  } catch (error) {    console.error('读取文件时出错:', error);    throw error;  }}

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

main();

readFile 方法接受文件路径和可选的编码参数（默认 null — 返回 Buffer）。如果指定 'utf-8'，将返回字符串。

2.2 写入文件

使用 writeFile 将数据写入文件。如果文件不存在，将被创建；如果存在，将被覆盖。

import { promises as fs } from 'fs';

async function writeFileExample(filePath: string, data: string): Promise<void> {  try {    await fs.writeFile(filePath, data, 'utf-8');    console.log('文件写入成功');  } catch (error) {    console.error('写入文件时出错:', error);    throw error;  }}

// 追加内容到文件末尾 (append)async function appendFileExample(filePath: string, data: string): Promise<void> {  try {    await fs.appendFile(filePath, data + '', 'utf-8');    console.log('数据已追加到文件末尾');  } catch (error) {    console.error('追加数据时出错:', error);    throw error;  }}