@scayle/unstorage-compression-driver/dist/index.d.ts

Compression driver for unstorage

import { Driver } from 'unstorage';

declare const CompressionAvailableEncoding: readonly ["none", "gzip", "brotli", "deflate"];
type CompressionEncodings = (typeof CompressionAvailableEncoding)[number];
type CompressionPayload = string | number | object;

interface CompressionDriverOptions {
    passthroughDriver: Driver;
    encoding: CompressionEncodings;
}
/**
 * @param driver Unstorage driver to be wrapped and passed compressed data
 * @param options CompressionDriver specific options
 */
declare const compressionDriver: (opts: CompressionDriverOptions) => Driver<CompressionDriverOptions, any>;

declare const compress: (value: CompressionPayload, encoding: CompressionEncodings) => Promise<CompressionPayload | undefined>;
declare const decompress: (value: string, encoding: CompressionEncodings) => Promise<CompressionPayload | undefined>;

// @ts-ignore
export = compressionDriver;
export { CompressionAvailableEncoding, compress, compressionDriver, decompress };
export type { CompressionDriverOptions, CompressionEncodings, CompressionPayload };