Class XzStream`Abstract`

Hierarchy (View Summary)

Transform
- XzStream
  - Xz
  - Unxz

Index

Constructors

Accessors

bytesRead bytesWritten

Methods

_flush _processChunk _transform close flush

Constructors

constructor

new XzStream(
    streamMode: number,
    opts?: LZMAOptions,
    options?: TransformOptions<Transform>,
): XzStream
Parameters
- streamMode: number
- opts: LZMAOptions = {}
- Optionaloptions: TransformOptions<Transform>
Returns XzStream
Overrides Transform.constructor
- Defined in lzma.ts:343

Accessors

bytesRead

get bytesRead(): number
Get total bytes read from input so far

Returns number
- Defined in lzma.ts:444

bytesWritten

get bytesWritten(): number
Get total bytes written to output so far

Returns number
- Defined in lzma.ts:449

Methods

_flush

_flush(callback: TransformCallback): void
Parameters
- callback: TransformCallback
Returns void
Overrides Transform._flush
- Defined in lzma.ts:566

_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
- Defined in lzma.ts:576

_transform

_transform(
    chunk: Buffer<ArrayBufferLike> | null,
    _encoding: string,
    callback: TransformCallback,
): void
Parameters
- chunk: Buffer<ArrayBufferLike> | null
- _encoding: string
- callback: TransformCallback
Returns void
Overrides Transform._transform
- Defined in lzma.ts:529

close

close(callback?: () => void): void
Parameters
- Optionalcallback: () => void
Returns void
- Defined in lzma.ts:508

flush

flush(callback?: () => void): void
Parameters
- Optionalcallback: () => void
Returns void
- Defined in lzma.ts:469
flush(kind: number, callback?: () => void): void
Parameters
- kind: number
- Optionalcallback: () => void
Returns void
- Defined in lzma.ts:470