circu.js
    Preparing search index...

    Interface Deflate

    Deflate stream for incremental compression

    interface Deflate {
        deflate(
            data: ArrayBuffer | Uint8Array<ArrayBufferLike>,
            flush?: number,
        ): ArrayBuffer;
        finish(data?: ArrayBuffer | Uint8Array<ArrayBufferLike>): ArrayBuffer;
        flush(flush?: number): ArrayBuffer;
        getTotalIn(): number;
        getTotalOut(): number;
        params(level: number, strategy: number): void;
        reset(): void;
    }
    Index

    Methods

    deflate finish flush getTotalIn getTotalOut params reset

    Methods

    • Process input data (incremental compression)

      Parameters

      • data: ArrayBuffer | Uint8Array<ArrayBufferLike>

        Input data chunk

      • Optionalflush: number

        Flush mode (optional)

      Returns ArrayBuffer

      Compressed output chunk

    • Finish compression and flush all remaining data

      Parameters

      • Optionaldata: ArrayBuffer | Uint8Array<ArrayBufferLike>

        Final input data (optional)

      Returns ArrayBuffer

      Final compressed output

    • Flush pending output

      Parameters

      • Optionalflush: number

        Flush mode (optional, default: SYNC_FLUSH)

      Returns ArrayBuffer

      Flushed compressed data

    • Get total bytes processed (input)

      Returns number

      Total input bytes

    • Get total bytes produced (output)

      Returns number

      Total output bytes

    • Change compression parameters on the fly

      Parameters

      • level: number

        New compression level

      • strategy: number

        New compression strategy

      Returns void

    • Reset compression state for reuse

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods