Module zlib

Interfaces

ZlibOptions

Properties

SP Z_ASCII: number

Type:
  • number

SP Z_BEST_COMPRESSION: number

Type:
  • number

SP Z_BEST_SPEED: number

Type:
  • number

SP Z_BINARY: number

Type:
  • number

SP Z_BLOCK: number

Type:
  • number

SP Z_BUF_ERROR: number

Type:
  • number

SP Z_DATA_ERROR: number

Type:
  • number

SP Z_DEFAULT_COMPRESSION: number

Type:
  • number

SP Z_DEFAULT_STRATEGY: number

Type:
  • number

SP Z_DEFLATED: number

Type:
  • number

SP Z_ERRNO: number

Type:
  • number

SP Z_FILTERED: number

Type:
  • number

SP Z_FINISH: number

Type:
  • number

SP Z_FIXED: number

Type:
  • number

SP Z_FULL_FLUSH: number

Type:
  • number

SP Z_HUFFMAN_ONLY: number

Type:
  • number

SP Z_MEM_ERROR: number

Type:
  • number

SP Z_NEED_DICT: number

Type:
  • number

SP Z_NO_COMPRESSION: number

Type:
  • number

SP Z_NO_FLUSH: number

Type:
  • number

SP Z_NULL: number

Type:
  • number

SP Z_OK: number

Type:
  • number

SP Z_PARTIAL_FLUSH: number

Type:
  • number

SP Z_RLE: number

Type:
  • number

SP Z_STREAM_END: number

Type:
  • number

SP Z_STREAM_ERROR: number

Type:
  • number

SP Z_SYNC_FLUSH: number

Type:
  • number

SP Z_TEXT: number

Type:
  • number

SP Z_TREES: number

Type:
  • number

SP Z_UNKNOWN: number

Type:
  • number

SP Z_VERSION_ERROR: number

Type:
  • number

Methods

SM createDeflate(options: zlib.ZlibOptions) zlib.Deflate

Parameters:
Name Type Argument
options zlib.ZlibOptions <optional>
Returns: { zlib.Deflate }

SM createDeflateRaw(options: zlib.ZlibOptions) zlib.DeflateRaw

Parameters:
Name Type Argument
options zlib.ZlibOptions <optional>
Returns: { zlib.DeflateRaw }

SM createGunzip(options: zlib.ZlibOptions) zlib.Gunzip

Parameters:
Name Type Argument
options zlib.ZlibOptions <optional>
Returns: { zlib.Gunzip }

SM createGzip(options: zlib.ZlibOptions) zlib.Gzip

Parameters:
Name Type Argument
options zlib.ZlibOptions <optional>
Returns: { zlib.Gzip }

SM createInflate(options: zlib.ZlibOptions) zlib.Inflate

Parameters:
Name Type Argument
options zlib.ZlibOptions <optional>
Returns: { zlib.Inflate }

SM createInflateRaw(options: zlib.ZlibOptions) zlib.InflateRaw

Parameters:
Name Type Argument
options zlib.ZlibOptions <optional>
Returns: { zlib.InflateRaw }

SM createUnzip(options: zlib.ZlibOptions) zlib.Unzip

Parameters:
Name Type Argument
options zlib.ZlibOptions <optional>
Returns: { zlib.Unzip }

SM deflate(buf: Buffer, callback: module:zlib.DeflateCallbackCallback) void

Parameters:
Name Type
buf Buffer
callback module:zlib.DeflateCallbackCallback
Returns: { void }

SM deflateRaw(buf: Buffer, callback: module:zlib.DeflateRawCallbackCallback) void

Parameters:
Name Type
buf Buffer
callback module:zlib.DeflateRawCallbackCallback
Returns: { void }

SM gunzip(buf: Buffer, callback: module:zlib.GunzipCallbackCallback) void

Parameters:
Name Type
buf Buffer
callback module:zlib.GunzipCallbackCallback
Returns: { void }

SM gzip(buf: Buffer, callback: module:zlib.GzipCallbackCallback) void

Parameters:
Name Type
buf Buffer
callback module:zlib.GzipCallbackCallback
Returns: { void }

SM inflate(buf: Buffer, callback: module:zlib.InflateCallbackCallback) void

Parameters:
Name Type
buf Buffer
callback module:zlib.InflateCallbackCallback
Returns: { void }

SM inflateRaw(buf: Buffer, callback: module:zlib.InflateRawCallbackCallback) void

Parameters:
Name Type
buf Buffer
callback module:zlib.InflateRawCallbackCallback
Returns: { void }

SM unzip(buf: Buffer, callback: module:zlib.UnzipCallbackCallback) void

Parameters:
Name Type
buf Buffer
callback module:zlib.UnzipCallbackCallback
Returns: { void }

Callbacks

DeflateCallbackCallback(error: Error, result: any) void

Parameters:
Name Type
error Error
result any
Returns: { void }

DeflateRawCallbackCallback(error: Error, result: any) void

Parameters:
Name Type
error Error
result any
Returns: { void }

GunzipCallbackCallback(error: Error, result: any) void

Parameters:
Name Type
error Error
result any
Returns: { void }

GzipCallbackCallback(error: Error, result: any) void

Parameters:
Name Type
error Error
result any
Returns: { void }

InflateCallbackCallback(error: Error, result: any) void

Parameters:
Name Type
error Error
result any
Returns: { void }

InflateRawCallbackCallback(error: Error, result: any) void

Parameters:
Name Type
error Error
result any
Returns: { void }

UnzipCallbackCallback(error: Error, result: any) void

Parameters:
Name Type
error Error
result any
Returns: { void }