Genotype API Documentation - v0.1.0
    Preparing search index...

    Function createDecompressor

    • Factory function to create appropriate decompressor based on format

      Provides a unified interface for creating decompressors while maintaining the flexibility to use format-specific optimizations.

      Parameters

      Returns
          | {
              decompress: (
                  compressed: Uint8Array,
                  options?: DecompressorOptions,
              ) => Promise<Uint8Array<ArrayBufferLike>>;
              createStream: (
                  options?: DecompressorOptions,
              ) => TransformStream<
                  Uint8Array<ArrayBufferLike>,
                  Uint8Array<ArrayBufferLike>,
              >;
              wrapStream: (
                  input: ReadableStream<Uint8Array<ArrayBufferLike>>,
                  options?: DecompressorOptions,
              ) => ReadableStream<Uint8Array<ArrayBufferLike>>;
          }
          | {
              decompress: (
                  compressed: Uint8Array,
                  options?: DecompressorOptions,
              ) => Promise<Uint8Array<ArrayBufferLike>>;
              createStream: (
                  options?: DecompressorOptions,
              ) => TransformStream<
                  Uint8Array<ArrayBufferLike>,
                  Uint8Array<ArrayBufferLike>,
              >;
              wrapStream: (
                  input: ReadableStream<Uint8Array<ArrayBufferLike>>,
                  options?: DecompressorOptions,
              ) => ReadableStream<Uint8Array<ArrayBufferLike>>;
          }

      Decompressor class with consistent interface

      • {
            decompress: (
                compressed: Uint8Array,
                options?: DecompressorOptions,
            ) => Promise<Uint8Array<ArrayBufferLike>>;
            createStream: (
                options?: DecompressorOptions,
            ) => TransformStream<
                Uint8Array<ArrayBufferLike>,
                Uint8Array<ArrayBufferLike>,
            >;
            wrapStream: (
                input: ReadableStream<Uint8Array<ArrayBufferLike>>,
                options?: DecompressorOptions,
            ) => ReadableStream<Uint8Array<ArrayBufferLike>>;
        }
        • decompress: (
              compressed: Uint8Array,
              options?: DecompressorOptions,
          ) => Promise<Uint8Array<ArrayBufferLike>>
        • createStream: (
              options?: DecompressorOptions,
          ) => TransformStream<
              Uint8Array<ArrayBufferLike>,
              Uint8Array<ArrayBufferLike>,
          >
        • wrapStream: (
              input: ReadableStream<Uint8Array<ArrayBufferLike>>,
              options?: DecompressorOptions,
          ) => ReadableStream<Uint8Array<ArrayBufferLike>>
      • {
            decompress: (
                compressed: Uint8Array,
                options?: DecompressorOptions,
            ) => Promise<Uint8Array<ArrayBufferLike>>;
            createStream: (
                options?: DecompressorOptions,
            ) => TransformStream<
                Uint8Array<ArrayBufferLike>,
                Uint8Array<ArrayBufferLike>,
            >;
            wrapStream: (
                input: ReadableStream<Uint8Array<ArrayBufferLike>>,
                options?: DecompressorOptions,
            ) => ReadableStream<Uint8Array<ArrayBufferLike>>;
        }
        • decompress: (
              compressed: Uint8Array,
              options?: DecompressorOptions,
          ) => Promise<Uint8Array<ArrayBufferLike>>
        • createStream: (
              options?: DecompressorOptions,
          ) => TransformStream<
              Uint8Array<ArrayBufferLike>,
              Uint8Array<ArrayBufferLike>,
          >
        • wrapStream: (
              input: ReadableStream<Uint8Array<ArrayBufferLike>>,
              options?: DecompressorOptions,
          ) => ReadableStream<Uint8Array<ArrayBufferLike>>

      If format is not supported

      const decompressor = createDecompressor('gzip');
      const result = await decompressor.decompress(compressedData);

    Settings

    Member Visibility