Variable default

Type Declaration

• check: { CRC32: any; CRC64: any; NONE: any; SHA256: any }

  Integrity check types for XZ streams. Use CRC64 for best balance of speed and error detection.

  Example

  const compressor = createXz({ check: check.CRC64 });
  Copy

• createUnxz: (lzmaOptions?: LZMAOptions, options?: TransformOptions<Transform>) => Unxz

• createXz: (lzmaOptions?: LZMAOptions, options?: TransformOptions<Transform>) => Xz

• filter: {
      ARM: any;
      ARMTHUMB: any;
      IA64: any;
      LZMA2: any;
      POWERPC: any;
      SPARC: any;
      X86: any;
  }

  Compression filters for preprocessing data before LZMA2. BCJ filters improve compression for executable code.

  Example

  // Compress x86 executable with BCJ filter
  const compressor = createXz({ filters: [filter.X86, filter.LZMA2] });
  Copy

  • ReadonlyARM: any

    BCJ filter for ARM executables

  • ReadonlyARMTHUMB: any

    BCJ filter for ARM-Thumb executables

  • ReadonlyIA64: any

    BCJ filter for IA-64 executables

  • ReadonlyLZMA2: any

    LZMA2 compression filter (required, must be last)

  • ReadonlyPOWERPC: any

    BCJ filter for PowerPC executables

  • ReadonlySPARC: any

    BCJ filter for SPARC executables

  • ReadonlyX86: any

    BCJ filter for x86 executables

• flag: {
      CONCATENATED: any;
      TELL_ANY_CHECK: any;
      TELL_NO_CHECK: any;
      TELL_UNSUPPORTED_CHECK: any;
  }

  Decoder flags for controlling decompression behavior.

  Example

  const decompressor = createUnxz({ flushFlag: flag.CONCATENATED });
  Copy

  • ReadonlyCONCATENATED: any

    Allow concatenated XZ streams

  • ReadonlyTELL_ANY_CHECK: any

    Tell decoder about any integrity check type

  • ReadonlyTELL_NO_CHECK: any

    Tell decoder if input has no integrity check

  • ReadonlyTELL_UNSUPPORTED_CHECK: any

    Tell decoder if integrity check is unsupported

• hasThreads: () => boolean

• LZMA_BUF_ERROR: any

• LZMA_DATA_ERROR: any

• LZMA_FILTER_ARM: any

• LZMA_FILTER_ARMTHUMB: any

• LZMA_FILTER_IA64: any

• LZMA_FILTER_POWERPC: any

• LZMA_FILTER_X86: any

• LZMA_FILTERS_MAX: any

• LZMA_FINISH: any

• LZMA_FORMAT_ERROR: any

• LZMA_FULL_FLUSH: any

• LZMA_GET_CHECK: any

• LZMA_MEM_ERROR: any

• LZMA_MEMLIMIT_ERROR: any

• LZMA_NO_CHECK: any

• LZMA_OK: any

• LZMA_OPTIONS_ERROR: any

• LZMA_PROG_ERROR: any

• LZMA_RUN: any

• LZMA_STREAM_END: any

• LZMA_SYNC_FLUSH: any

• LZMA_UNSUPPORTED_CHECK: any

• messages: readonly string[]

  Array of error messages indexed by LZMA status code.

  Deprecated

  Use LZMAErrorMessage enum instead

• mode: { FAST: any; NORMAL: any }

  Compression mode selection. FAST uses less memory, NORMAL provides better compression.

  • ReadonlyFAST: any

    Fast compression mode - less memory, faster

  • ReadonlyNORMAL: any

    Normal compression mode - better ratio

• preset: { DEFAULT: any; EXTREME: any }

  Compression preset flags. Can be combined with preset level using bitwise OR.

  Example

  const compressor = createXz({ preset: 6 | preset.EXTREME });
  Copy

  • ReadonlyDEFAULT: any

    Default compression level (6)

  • ReadonlyEXTREME: any

    Extreme mode flag - slower but better compression

• unxz: {
      (
          buffer: string | Buffer<ArrayBufferLike>,
          callback: CompressionCallback,
      ): void;
      (
          buffer: string | Buffer<ArrayBufferLike>,
          opts: LZMAOptions,
          callback: CompressionCallback,
      ): void;
  }

• Unxz: typeof Unxz

• unxzAsync: (
      buffer: string | Buffer<ArrayBufferLike>,
      opts?: LZMAOptions,
  ) => Promise<Buffer<ArrayBufferLike>>

• unxzSync: (buffer: string | Buffer<ArrayBufferLike>, opts?: LZMAOptions) => Buffer

• xz: {
      (
          buffer: string | Buffer<ArrayBufferLike>,
          callback: CompressionCallback,
      ): void;
      (
          buffer: string | Buffer<ArrayBufferLike>,
          opts: LZMAOptions,
          callback: CompressionCallback,
      ): void;
  }

• Xz: typeof Xz

• xzAsync: (
      buffer: string | Buffer<ArrayBufferLike>,
      opts?: LZMAOptions,
  ) => Promise<Buffer<ArrayBufferLike>>

• XzStream: typeof XzStream

• xzSync: (buffer: string | Buffer<ArrayBufferLike>, opts?: LZMAOptions) => Buffer