react-native-compressor/lib/typescript/Image/index.d.ts

Compress Image, Video, and Audio same like Whatsapp & Auto/Manual Compression | Background Upload | Download File | Create Video Thumbnail

export type InputType = 'base64' | 'uri';
export type OutputType = 'jpg' | 'png';
export type ReturnableOutputType = 'uri' | 'base64';
export type compressionMethod = 'auto' | 'manual';
export type CompressorOptions = {
    /***
     * The compression method to use.
     */
    compressionMethod?: compressionMethod;
    /***
     * The maximum width boundary used when compressing a landscape image.
     */
    maxWidth?: number;
    /***
     * The maximum height boundary used when compressing a portrait image.
     */
    maxHeight?: number;
    /***
     * The compression factor used when compressing JPEG images. Won't be used in PNG.
     */
    quality?: number;
    /***
     * The type of data the input value contains.
     */
    input?: InputType;
    /***
     * The output image type.
     */
    output?: OutputType;
    /***
     * when user add `output:'png'` then by default compressed image will have transparent background, and quality will be ignored, if you wanna apply quality then you have to disablePngTransparency like `disablePngTransparency:true`, it will convert transparent background to white
     */
    disablePngTransparency?: boolean;
    /***
     * The output that will return to user.
     */
    returnableOutputType?: ReturnableOutputType;
    /***
     * it is callback, only trigger when we pass image url from server
     */
    downloadProgress?: (progress: number) => void;
    /***
     * Default:0, we uses when we use downloadProgress
     */
    progressDivider?: number;
};
type ImageType = {
    compress(value: string, options?: CompressorOptions): Promise<string>;
};
declare const Image: ImageType;
export default Image;
//# sourceMappingURL=index.d.ts.map