Module 基礎模塊

模塊zlib

zlib 壓縮解壓模塊

使用方法:

1
var zlib = require('zlib');

靜態函數

createDeflate

創建一個deflate 流對象

1
static Stream zlib.createDeflate(Stream to);

調用參數:

  • to: Stream, 用於存儲處理結果的流

返回結果:

  • Stream, 返回封裝過的流對象

createDeflateRaw

創建一個deflateRaw 流對象

1
static Stream zlib.createDeflateRaw(Stream to);

調用參數:

  • to: Stream, 用於存儲處理結果的流

返回結果:

  • Stream, 返回封裝過的流對象

createGunzip

創建一個gunzip 流對象

1 2
static Stream zlib.createGunzip(Stream to, Integer maxSize = -1);

調用參數:

  • to: Stream, 用於存儲處理結果的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

返回結果:

  • Stream, 返回封裝過的流對象

createGzip

創建一個gzip 流對象

1
static Stream zlib.createGzip(Stream to);

調用參數:

  • to: Stream, 用於存儲處理結果的流

返回結果:

  • Stream, 返回封裝過的流對象

createInflate

創建一個inflate 流對象

1 2
static Stream zlib.createInflate(Stream to, Integer maxSize = -1);

調用參數:

  • to: Stream, 用於存儲處理結果的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

返回結果:

  • Stream, 返回封裝過的流對象

createInflateRaw

創建一個inflateRaw 流對象

1 2
static Stream zlib.createInflateRaw(Stream to, Integer maxSize = -1);

調用參數:

  • to: Stream, 用於存儲處理結果的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

返回結果:

  • Stream, 返回封裝過的流對象

deflate

使用deflate 算法壓縮數據(zlib格式)

1 2
static Buffer zlib.deflate(Buffer data, Integer level = DEFAULT_COMPRESSION) async;

調用參數:

  • data: Buffer, 給定要壓縮的數據
  • level: Integer, 指定壓縮級別,缺省為DEFAULT_COMPRESSION

返回結果:

  • Buffer, 返回壓縮後的二進制數據

deflateTo

使用deflate 算法壓縮數據到流對像中(zlib格式)

1 2 3
static zlib.deflateTo(Buffer data, Stream stm, Integer level = DEFAULT_COMPRESSION) async;

調用參數:

  • data: Buffer, 給定要壓縮的數據
  • stm: Stream, 指定存儲壓縮數據的流
  • level: Integer, 指定壓縮級別,缺省為DEFAULT_COMPRESSION

使用deflate 算法壓縮源流中的數據到流對像中(zlib格式)

1 2 3
static zlib.deflateTo(Stream src, Stream stm, Integer level = DEFAULT_COMPRESSION) async;

調用參數:

  • src: Stream, 給定要壓縮的數據所在的流
  • stm: Stream, 指定存儲壓縮數據的流
  • level: Integer, 指定壓縮級別,缺省為DEFAULT_COMPRESSION

inflate

解壓縮deflate 算法壓縮的數據(zlib格式)

1 2
static Buffer zlib.inflate(Buffer data, Integer maxSize = -1) async;

調用參數:

  • data: Buffer, 給定壓縮後的數據
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

返回結果:

  • Buffer, 返回解壓縮後的二進制數據

inflateTo

解壓縮deflate 算法壓縮的數據到流對像中(zlib格式)

1 2 3
static zlib.inflateTo(Buffer data, Stream stm, Integer maxSize = -1) async;

調用參數:

  • data: Buffer, 給定要解壓縮的數據
  • stm: Stream, 指定存儲解壓縮數據的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

解壓縮源流中deflate 算法壓縮的數據到流對像中(zlib格式)

1 2 3
static zlib.inflateTo(Stream src, Stream stm, Integer maxSize = -1) async;

調用參數:

  • src: Stream, 給定要解壓縮的數據所在的流
  • stm: Stream, 指定存儲解壓縮數據的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

gzip

使用gzip 算法壓縮數據

1
static Buffer zlib.gzip(Buffer data) async;

調用參數:

  • data: Buffer, 給定要壓縮的數據

返回結果:

  • Buffer, 返回壓縮後的二進制數據

gzipTo

使用gzip 算法壓縮數據到流對像中

1 2
static zlib.gzipTo(Buffer data, Stream stm) async;

調用參數:

  • data: Buffer, 給定要壓縮的數據
  • stm: Stream, 指定存儲壓縮數據的流

使用gzip 算法壓縮源流中的數據到流對像中

1 2
static zlib.gzipTo(Stream src, Stream stm) async;

調用參數:

  • src: Stream, 給定要壓縮的數據所在的流
  • stm: Stream, 指定存儲壓縮數據的流

gunzip

解壓縮gzip 算法壓縮的數據

1 2
static Buffer zlib.gunzip(Buffer data, Integer maxSize = -1) async;

調用參數:

  • data: Buffer, 給定壓縮後的數據
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

返回結果:

  • Buffer, 返回解壓縮後的二進制數據

gunzipTo

解壓縮gzip 算法壓縮的數據到流對像中

1 2 3
static zlib.gunzipTo(Buffer data, Stream stm, Integer maxSize = -1) async;

調用參數:

  • data: Buffer, 給定要解壓縮的數據
  • stm: Stream, 指定存儲解壓縮數據的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

解壓縮源流中gzip 算法壓縮的數據到流對像中

1 2 3
static zlib.gunzipTo(Stream src, Stream stm, Integer maxSize = -1) async;

調用參數:

  • src: Stream, 給定要解壓縮的數據所在的流
  • stm: Stream, 指定存儲解壓縮數據的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

deflateRaw

使用deflate 算法壓縮數據(deflateRaw)

1 2
static Buffer zlib.deflateRaw(Buffer data, Integer level = DEFAULT_COMPRESSION) async;

調用參數:

  • data: Buffer, 給定要壓縮的數據
  • level: Integer, 指定壓縮級別,缺省為DEFAULT_COMPRESSION

返回結果:

  • Buffer, 返回壓縮後的二進制數據

deflateRawTo

使用deflate 算法壓縮數據到流對像中(deflateRaw)

1 2 3
static zlib.deflateRawTo(Buffer data, Stream stm, Integer level = DEFAULT_COMPRESSION) async;

調用參數:

  • data: Buffer, 給定要壓縮的數據
  • stm: Stream, 指定存儲壓縮數據的流
  • level: Integer, 指定壓縮級別,缺省為DEFAULT_COMPRESSION

使用deflate 算法壓縮源流中的數據到流對像中(deflateRaw)

1 2 3
static zlib.deflateRawTo(Stream src, Stream stm, Integer level = DEFAULT_COMPRESSION) async;

調用參數:

  • src: Stream, 給定要壓縮的數據所在的流
  • stm: Stream, 指定存儲壓縮數據的流
  • level: Integer, 指定壓縮級別,缺省為DEFAULT_COMPRESSION

inflateRaw

解壓縮deflate 算法壓縮的數據(inflateRaw)

1 2
static Buffer zlib.inflateRaw(Buffer data, Integer maxSize = -1) async;

調用參數:

  • data: Buffer, 給定壓縮後的數據
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

返回結果:

  • Buffer, 返回解壓縮後的二進制數據

inflateRawTo

解壓縮deflate 算法壓縮的數據到流對像中(inflateRaw)

1 2 3
static zlib.inflateRawTo(Buffer data, Stream stm, Integer maxSize = -1) async;

調用參數:

  • data: Buffer, 給定要解壓縮的數據
  • stm: Stream, 指定存儲解壓縮數據的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

解壓縮源流中deflate 算法壓縮的數據到流對像中(inflateRaw)

1 2 3
static zlib.inflateRawTo(Stream src, Stream stm, Integer maxSize = -1) async;

調用參數:

  • src: Stream, 給定要解壓縮的數據所在的流
  • stm: Stream, 指定存儲解壓縮數據的流
  • maxSize: Integer, 指定解壓縮尺寸限制,缺省為-1,不限制

常量

NO_COMPRESSION

deflate 壓縮級別,設定不壓縮

1
const zlib.NO_COMPRESSION = 0;

BEST_SPEED

deflate 壓縮級別,設定最快壓縮

1
const zlib.BEST_SPEED = 1;

BEST_COMPRESSION

deflate 壓縮級別,設定最高壓縮

1
const zlib.BEST_COMPRESSION = 9;

DEFAULT_COMPRESSION

deflate 壓縮級別,設定缺省設置

1
const zlib.DEFAULT_COMPRESSION = -1;