@hpcc-js/wasm-zstd/types/zstd.d.ts

hpcc-js - WASM zstd

import { WasmLibrary } from "./wasm-library.ts";
/**
 * The Zstandard WASM library, provides a simplified wrapper around the Zstandard c++ library.
 *
 * See [Zstandard](https://facebook.github.io/zstd/) for more details.
 *
 * ```ts
 * import { Zstd } from "@hpcc-js/wasm-zstd";
 *
 * const zstd = await Zstd.load();
 *
 * //  Generate some "data"
 * const data = new Uint8Array(Array.from({ length: 100000 }, (_, i) => i % 256));
 *
 * const compressed_data = zstd.compress(data);
 * const decompressed_data = zstd.decompress(compressed_data);
 * ```
 */
export declare class Zstd extends WasmLibrary {
    private constructor();
    /**
     * Compiles and instantiates the raw wasm.
     *
     * ::: info
     * In general WebAssembly compilation is disallowed on the main thread if the buffer size is larger than 4KB, hence forcing `load` to be asynchronous;
     * :::
     *
     * @returns A promise to an instance of the Zstd class.
     */
    static load(): Promise<Zstd>;
    /**
     * Unloades the compiled wasm instance.
     */
    static unload(): void;
    /**
     * @returns The Zstd c++ version
     */
    version(): string;
    /**
     * @param data Data to be compressed
     * @param compressionLevel Compression v Speed tradeoff, when omitted it will default to `zstd.defaultCLevel()` which is currently 3.
     * @returns Compressed data.
     *
     * :::tip
     * A note on compressionLevel:  The library supports regular compression levels from 1 up o 22. Levels >= 20, should be used with caution, as they require more memory. The library also offers negative compression levels, which extend the range of speed vs. ratio preferences.  The lower the level, the faster the speed (at the cost of compression).
     * :::
     */
    compress(data: Uint8Array, compressionLevel?: number): Uint8Array;
    /**
     * @param compressedData Data to be compressed
     * @returns Uncompressed data.
     */
    decompress(compressedData: Uint8Array): Uint8Array;
    /**
     * @returns Default compression level (see notes above above).
     */
    defaultCLevel(): number;
    minCLevel(): number;
    maxCLevel(): number;
}