TypeScript 文件系统操作完全指南

TypeScript 中文件系统操作入门

TypeScript 是 JavaScript 的强类型扩展，它添加了静态类型检查，提高了代码的可读性和可维护性。开发服务器端应用程序时，关键任务之一就是处理文件系统：读写文件、创建和删除目录、管理数据流。本文将详细讲解如何利用 Node.js 内置的 fs 模块，在 TypeScript 中高效地操作文件系统。

fs 模块提供了同步和异步两种方法来与文件系统交互。在 TypeScript 中，我们可以利用类型系统的优势，使代码更加健壮和清晰。我们将介绍基本操作，包括读取、写入、检查文件是否存在、处理目录以及错误处理。

基本文件操作

读取文件

在 TypeScript 中，可以使用 readFile（异步）或 readFileSync（同步）方法来读取文件内容。推荐使用异步方式，以避免阻塞程序执行。

import { readFile } from 'fs/promises';

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

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

注意这里使用了 fs/promises —— 这是一个 Promise 封装，允许使用 async/await 语法。返回值类型 Promise<string> 明确表示该函数返回一个字符串。

写入文件

向文件写入数据可以使用 writeFile 和 writeFileSync 方法。在 TypeScript 中，正确处理可能出现的错误非常重要，特别是当文件被写保护或路径不存在时。

import { writeFile, mkdir } from 'fs/promises';import { existsSync } from 'fs';

async function writeFileExample(filePath: string, data: string): Promise<void> {  try {    // 检查目录是否存在    const dir = filePath.substring(0, filePath.lastIndexOf('/'));    if (dir && !existsSync(dir)) {      await mkdir(dir, { recursive: true });    }    await writeFile(filePath, data, 'utf-8');    console.log('文件写入成功');  } catch (error) {    console.error('写入文件时出错:', error);  }}

// 使用示例writeFileExample('data/output.txt', 'Hello, TypeScript!');

在这个例子中，我们首先检查目录是否存在，如果不存在则使用 mkdir 并设置 recursive: true 选项来创建它。这可以避免因父文件夹不存在而导致的 "ENOENT" 错误。

追加数据到文件末尾

如果需要向现有文件追加数据，请使用 appendFile 方法：

import { appendFile } from 'fs/promises';

async function appendToFile(filePath: string, data: string): Promise<void> {  try {    await appendFile(filePath, '' + data, 'utf-8');    console.log('数据已追加');  } catch (error) {    console.error('追加数据时出错:', error);  }}

目录操作

创建和删除目录

创建目录使用 mkdir，删除目录使用 rmdir 或 rm（用于递归删除）。在 TypeScript 中，可以方便地使用泛型来对路径进行类型化。

import { mkdir, rmdir, rm } from 'fs/promises';import { existsSync } from 'fs';

async function createDirectory(di
```