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

deflateSyncメソッドは、指定されたデータをDeflateアルゴリズムを用いて同期的に圧縮するメソッドです。Node.jsのzlibモジュールの一部として提供されています。

このメソッドは、Buffer、TypedArray、またはDataView形式で渡された入力データを、標準的なDeflate圧縮方式で処理します。同期処理であるため、圧縮処理が完了するまでプログラムの実行を一時停止させます。この特性により、圧縮結果をすぐに利用できる利点がありますが、処理中に他の操作がブロックされるため、アプリケーション全体の応答性が低下する可能性があります。

圧縮したいデータと、オプション設定を引数として受け取り、圧縮されたデータが格納されたBufferオブジェクトを戻り値として直接返します。そのため、非常に小さなデータを圧縮する場合や、起動時の設定ファイルの処理など、プログラムの実行をブロックしても問題ない場面での利用に適しています。大量のデータを扱う際や、Webサーバーなどの応答性が求められるアプリケーションでは、非同期版のzlib.deflate()メソッドを使用することが推奨されます。

Copy
1const zlib = require('node:zlib');
2
3const inputBuffer = Buffer.from('This is a string to be compressed using deflate.');
4const compressedBuffer = zlib.deflateSync(inputBuffer, { level: 9 });

buffer, opts = {}

• buffer: Buffer: 圧縮するデータを含むBufferオブジェクト
• opts: object = {}: 圧縮オプションを指定するオブジェクト。省略可能。

Buffer

Node.js の Object.prototype.deflateSync() メソッドは、指定されたオブジェクトを圧縮したバイナリデータである Buffer オブジェクトを返します。