node-liblzma - v3.1.2
    Preparing search index...

    Class XzStreamAbstract

    Abstract base class for XZ compression/decompression streams. Extends Node.js Transform stream with LZMA2 encoding/decoding.

    // Use Xz or Unxz classes instead of XzStream directly
    const compressor = new Xz({ preset: 6 });
    readStream.pipe(compressor).pipe(writeStream);

    Emits progress event after each chunk with {bytesRead, bytesWritten} info.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    bytesRead bytesWritten

    Methods

    _flush _processChunk _transform close flush

    Constructors

    • Parameters

      • streamMode: number
      • opts: LZMAOptions = {}
      • Optionaloptions: TransformOptions<Transform>

      Returns XzStream

    Accessors

    • get bytesRead(): number

      Get total bytes read from input so far

      Returns number

    • get bytesWritten(): number

      Get total bytes written to output so far

      Returns number

    Methods

    _flush

    • _flush(callback: TransformCallback): void

      Parameters

      • callback: TransformCallback

      Returns void

    _processChunk

    • _processChunk(
          chunk: Buffer<ArrayBufferLike> | null,
          flushFlag: number,
          cb?: TransformCallback,
      ): Buffer<ArrayBufferLike> | undefined

      Parameters

      • chunk: Buffer<ArrayBufferLike> | null
      • flushFlag: number
      • Optionalcb: TransformCallback

      Returns Buffer<ArrayBufferLike> | undefined

    _transform

    • _transform(
          chunk: Buffer<ArrayBufferLike> | null,
          _encoding: string,
          callback: TransformCallback,
      ): void

      Parameters

      • chunk: Buffer<ArrayBufferLike> | null
      • _encoding: string
      • callback: TransformCallback

      Returns void

    • Parameters

      • Optionalcallback: () => void

      Returns void

    • Parameters

      • Optionalcallback: () => void

      Returns void

    • Parameters

      • kind: number
      • Optionalcallback: () => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods