Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

truncateSyncメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

truncateSyncメソッドは、Node.jsのファイルシステムモジュール(fsモジュール)の一部として提供され、ファイルのサイズを同期的に変更するメソッドです。このメソッドは、指定されたファイルパスのサイズを、新しい指定サイズ(バイト単位)に切り詰めるか、または拡張します。

具体的には、もし新しいサイズが現在のファイルサイズよりも小さい場合、ファイルは指定された新しいサイズまで切り詰められ、超過した末尾のデータは完全に失われます。逆に、新しいサイズが現在のファイルサイズよりも大きい場合、ファイルは指定されたサイズまで拡張されます。この際、新しく追加された領域は通常、ヌルバイト(\0)で埋められます。

「同期的に」とは、この処理が完了するまでプログラムの他の部分の実行が一時停止することを意味します。つまり、ファイルのサイズ変更処理が完全に終わるまで、次のコード行は実行されません。これによりコードは簡潔になりますが、特に大規模なファイル操作や、サーバーアプリケーションのように多数のユーザーからのリクエストを処理する環境では、プログラム全体がブロックされてしまう可能性があるため、注意が必要です。

このメソッドを使用する際は、ファイルが見つからない場合や、アクセス権限がない場合など、何らかのエラーが発生すると例外がスローされます。そのため、エラーが発生してもプログラムがクラッシュしないよう、try-catch文などを用いて適切にエラーをハンドリングする必要があります。手軽なスクリプトやユーティリティなど、同期処理が許容される環境での利用に適しています。

構文(syntax)

1const fs = require('node:fs');
2
3fs.truncateSync(path[, len]);

引数(parameters)

path, len = 0

  • path: string:Truncate するファイルのパス。
  • len: number = 0:Truncate 後のファイルのサイズ(バイト単位)。デフォルトは 0。

戻り値(return)

戻り値なし

戻り値はありません

関連コンテンツ

関連プログラミング言語