【Node.js24.x】Object::ftruncateSync()メソッドの使い方
ftruncateSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
ftruncateSyncメソッドは、指定されたファイルのサイズを同期的に変更（切り詰めたり、拡張したり）するメソッドです。主にファイルの末尾を特定の位置で切り詰めるために使用されます。このメソッドは、操作対象のファイルディスクリプタ（またはファイルパス）と、ファイルに設定したい新しいサイズ（バイト単位）を引数として受け取ります。
現在のファイルサイズが指定した新しいサイズよりも大きい場合、ファイルはその新しいサイズまで切り詰められます。この際、切り捨てられた部分のデータは完全に失われますので、データの扱いに注意が必要です。逆に、現在のファイルサイズが指定した新しいサイズよりも小さい場合、ファイルはそのサイズまで拡張されます。拡張された新しい領域は、通常ヌルバイト（0x00）で自動的に埋められます。
このftruncateSyncメソッドは同期処理であるため、ファイル操作が完了するまで、Node.jsのイベントループを含むプログラム全体の実行をブロックします。そのため、I/O処理中にアプリケーションが一時的に応答しなくなる可能性があります。大規模なファイルや、高いパフォーマンスが求められる環境で頻繁にこの操作を行う場合は、非同期版のftruncateメソッドを使用することが一般的に推奨されます。このメソッドは、Node.jsのファイルシステム機能を提供するfsモジュールに属しています。
構文(syntax)
1const fs = require('node:fs'); 2 3const fd = fs.openSync('example.txt', 'w+'); 4fs.ftruncateSync(fd, 1024); 5fs.closeSync(fd);
引数(parameters)
fd, len = 0
- fd: number: 変更したいファイルディスクリプタ
- len: number = 0: ファイルの新しいサイズを指定する数値。デフォルトは0
戻り値(return)
戻り値なし
戻り値はありません