【Node.js24.x】Object::ftruncate()メソッドの使い方

ftruncateメソッドは、開かれているファイルのサイズを変更する機能を提供するメソッドです。Node.jsのファイルシステムモジュール（fsモジュール）で提供され、ファイルディスクリプタ（fd）で指定されたファイルを操作します。

このメソッドは、ファイルディスクリプタと新しいファイルの長さをバイト単位で指定します。指定した長さが現在のファイルサイズより短ければ、ファイルはその位置で切り詰められ、余分なデータは失われます。逆に、指定した長さが現在のファイルサイズより長ければ、ファイルはその長さまで拡張され、追加された領域は通常ヌルバイト（0x00）で埋められます。新しい長さの指定を省略すると、ファイルは長さ0に切り詰められ、その内容がすべて削除されます。

ftruncateメソッドは非同期的に動作し、処理の完了はコールバック関数またはPromiseを通じて通知されます。システムエンジニアにとって、このメソッドはディスク領域の効率的な管理や、特定のファイル内容をクリアする際に有用です。ファイルの内容を直接変更する強力な操作であるため、データの消失を防ぐためにも、使用する際は必ず適切なバックアップとエラーハンドリングを行うことが非常に重要です。

Copy
1import { open } from 'node:fs/promises';
2
3async function example() {
4  let filehandle;
5  try {
6    filehandle = await open('example.txt', 'r+');
7    await filehandle.ftruncate(10);
8  } finally {
9    if (filehandle) {
10      await filehandle.close();
11    }
12  }
13}
14example();

fd, len = 0, callback

• fd: File descriptor: ファイルディスクリプタ。操作対象のファイルを表す整数。
• len: length: number = 0: ファイルを切り詰める新しいバイト長。デフォルトは0。
• callback: Function: ファイル操作完了時に呼び出されるコールバック関数。エラーが発生した場合はエラーオブジェクトが引数として渡されます。

Promise<void>

ftruncateメソッドは、指定されたファイルディスクリプタのサイズを指定された長さに切り詰める操作を非同期で行います。この操作が完了した際に、結果をPromiseで返しますが、実際の値はありません。