Options
All
  • Public
  • Public/Protected
  • All
Menu

Module next-server/server/lib/squoosh/codecs

Index

Variables

Variables

Const codecs

codecs: { mozjpeg: { autoOptimize: { max: 100; min: 0; option: "quality" }; dec: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; defaultEncoderOptions: { arithmetic: false; auto_subsample: true; baseline: false; chroma_quality: 75; chroma_subsample: 2; color_space: 3; optimize_coding: true; progressive: true; quality: 75; quant_table: 3; separate_chroma_quality: false; smoothing: 0; trellis_loops: 1; trellis_multipass: false; trellis_opt_table: false; trellis_opt_zero: false }; detectors: readonly [RegExp]; enc: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; extension: "jpg"; name: "MozJPEG" }; oxipng: { autoOptimize: { max: 1; min: 6; option: "level" }; dec: () => Promise<{ decode: any }>; defaultEncoderOptions: { level: 2 }; detectors: readonly [RegExp]; enc: () => Promise<{ encode: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => any }>; extension: "png"; name: "OxiPNG" }; webp: { autoOptimize: { max: 100; min: 0; option: "quality" }; dec: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; defaultEncoderOptions: { alpha_compression: 1; alpha_filtering: 1; alpha_quality: 100; autofilter: 0; emulate_jpeg_size: 0; exact: 0; filter_sharpness: 0; filter_strength: 60; filter_type: 1; image_hint: 0; lossless: 0; low_memory: 0; method: 4; near_lossless: 100; partition_limit: 0; partitions: 0; pass: 1; preprocessing: 0; quality: 75; segments: 4; show_compressed: 0; sns_strength: 50; target_PSNR: 0; target_size: 0; thread_level: 0; use_delta_palette: 0; use_sharp_yuv: 0 }; detectors: readonly [RegExp]; enc: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; extension: "webp"; name: "WebP" } }

Type declaration

  • Readonly mozjpeg: { autoOptimize: { max: 100; min: 0; option: "quality" }; dec: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; defaultEncoderOptions: { arithmetic: false; auto_subsample: true; baseline: false; chroma_quality: 75; chroma_subsample: 2; color_space: 3; optimize_coding: true; progressive: true; quality: 75; quant_table: 3; separate_chroma_quality: false; smoothing: 0; trellis_loops: 1; trellis_multipass: false; trellis_opt_table: false; trellis_opt_zero: false }; detectors: readonly [RegExp]; enc: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; extension: "jpg"; name: "MozJPEG" }
    • Readonly autoOptimize: { max: 100; min: 0; option: "quality" }
      • Readonly max: 100
      • Readonly min: 0
      • Readonly option: "quality"
    • Readonly dec: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • (): { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • Returns { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }

          • Optional decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

          • Optional encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

    • Readonly defaultEncoderOptions: { arithmetic: false; auto_subsample: true; baseline: false; chroma_quality: 75; chroma_subsample: 2; color_space: 3; optimize_coding: true; progressive: true; quality: 75; quant_table: 3; separate_chroma_quality: false; smoothing: 0; trellis_loops: 1; trellis_multipass: false; trellis_opt_table: false; trellis_opt_zero: false }
      • Readonly arithmetic: false
      • Readonly auto_subsample: true
      • Readonly baseline: false
      • Readonly chroma_quality: 75
      • Readonly chroma_subsample: 2
      • Readonly color_space: 3
      • Readonly optimize_coding: true
      • Readonly progressive: true
      • Readonly quality: 75
      • Readonly quant_table: 3
      • Readonly separate_chroma_quality: false
      • Readonly smoothing: 0
      • Readonly trellis_loops: 1
      • Readonly trellis_multipass: false
      • Readonly trellis_opt_table: false
      • Readonly trellis_opt_zero: false
    • Readonly detectors: readonly [RegExp]
    • Readonly enc: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • (): { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • Returns { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }

          • Optional decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

          • Optional encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

    • Readonly extension: "jpg"
    • Readonly name: "MozJPEG"
  • Readonly oxipng: { autoOptimize: { max: 1; min: 6; option: "level" }; dec: () => Promise<{ decode: any }>; defaultEncoderOptions: { level: 2 }; detectors: readonly [RegExp]; enc: () => Promise<{ encode: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => any }>; extension: "png"; name: "OxiPNG" }
    • Readonly autoOptimize: { max: 1; min: 6; option: "level" }
      • Readonly max: 1
      • Readonly min: 6
      • Readonly option: "level"
    • Readonly dec: () => Promise<{ decode: any }>
        • (): Promise<{ decode: any }>
        • Returns Promise<{ decode: any }>

    • Readonly defaultEncoderOptions: { level: 2 }
      • Readonly level: 2
    • Readonly detectors: readonly [RegExp]
    • Readonly enc: () => Promise<{ encode: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => any }>
        • (): Promise<{ encode: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => any }>
        • Returns Promise<{ encode: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => any }>

    • Readonly extension: "png"
    • Readonly name: "OxiPNG"
  • Readonly webp: { autoOptimize: { max: 100; min: 0; option: "quality" }; dec: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; defaultEncoderOptions: { alpha_compression: 1; alpha_filtering: 1; alpha_quality: 100; autofilter: 0; emulate_jpeg_size: 0; exact: 0; filter_sharpness: 0; filter_strength: 60; filter_type: 1; image_hint: 0; lossless: 0; low_memory: 0; method: 4; near_lossless: 100; partition_limit: 0; partitions: 0; pass: 1; preprocessing: 0; quality: 75; segments: 4; show_compressed: 0; sns_strength: 50; target_PSNR: 0; target_size: 0; thread_level: 0; use_delta_palette: 0; use_sharp_yuv: 0 }; detectors: readonly [RegExp]; enc: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }; extension: "webp"; name: "WebP" }
    • Readonly autoOptimize: { max: 100; min: 0; option: "quality" }
      • Readonly max: 100
      • Readonly min: 0
      • Readonly option: "quality"
    • Readonly dec: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • (): { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • Returns { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }

          • Optional decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

          • Optional encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

    • Readonly defaultEncoderOptions: { alpha_compression: 1; alpha_filtering: 1; alpha_quality: 100; autofilter: 0; emulate_jpeg_size: 0; exact: 0; filter_sharpness: 0; filter_strength: 60; filter_type: 1; image_hint: 0; lossless: 0; low_memory: 0; method: 4; near_lossless: 100; partition_limit: 0; partitions: 0; pass: 1; preprocessing: 0; quality: 75; segments: 4; show_compressed: 0; sns_strength: 50; target_PSNR: 0; target_size: 0; thread_level: 0; use_delta_palette: 0; use_sharp_yuv: 0 }
      • Readonly alpha_compression: 1
      • Readonly alpha_filtering: 1
      • Readonly alpha_quality: 100
      • Readonly autofilter: 0
      • Readonly emulate_jpeg_size: 0
      • Readonly exact: 0
      • Readonly filter_sharpness: 0
      • Readonly filter_strength: 60
      • Readonly filter_type: 1
      • Readonly image_hint: 0
      • Readonly lossless: 0
      • Readonly low_memory: 0
      • Readonly method: 4
      • Readonly near_lossless: 100
      • Readonly partition_limit: 0
      • Readonly partitions: 0
      • Readonly pass: 1
      • Readonly preprocessing: 0
      • Readonly quality: 75
      • Readonly segments: 4
      • Readonly show_compressed: 0
      • Readonly sns_strength: 50
      • Readonly target_PSNR: 0
      • Readonly target_size: 0
      • Readonly thread_level: 0
      • Readonly use_delta_palette: 0
      • Readonly use_sharp_yuv: 0
    • Readonly detectors: readonly [RegExp]
    • Readonly enc: () => { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • (): { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }
        • Returns { decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer; encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer }

          • Optional decode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

          • Optional encode?: (buffer: Uint8Array | Buffer, width: number, height: number, opts: any) => Buffer
              • (buffer: Uint8Array | Buffer, width: number, height: number, opts: any): Buffer
              • Parameters

                • buffer: Uint8Array | Buffer
                • width: number
                • height: number
                • opts: any

                Returns Buffer

    • Readonly extension: "webp"
    • Readonly name: "WebP"

Const preprocessors

preprocessors: { resize: { defaultOptions: { fitMethod: "stretch"; linearRGB: true; method: "lanczos3"; premultiply: true }; description: "Resize the image before compressing"; instantiate: () => Promise<(buffer: Uint8Array | Buffer, input_width: number, input_height: number, { width, height, method, premultiply, linearRGB, }: { height?: number; linearRGB: boolean; method: "triangle" | "catrom" | "mitchell" | "lanczos3"; premultiply: boolean; width?: number }) => default>; name: "Resize" }; rotate: { defaultOptions: { numRotations: 0 }; description: "Rotate image"; instantiate: () => Promise<(buffer: Uint8Array | Buffer, width: number, height: number, { numRotations }: { numRotations: number }) => Promise<default>>; name: "Rotate" } }

Type declaration

  • Readonly resize: { defaultOptions: { fitMethod: "stretch"; linearRGB: true; method: "lanczos3"; premultiply: true }; description: "Resize the image before compressing"; instantiate: () => Promise<(buffer: Uint8Array | Buffer, input_width: number, input_height: number, { width, height, method, premultiply, linearRGB, }: { height?: number; linearRGB: boolean; method: "triangle" | "catrom" | "mitchell" | "lanczos3"; premultiply: boolean; width?: number }) => default>; name: "Resize" }
    • Readonly defaultOptions: { fitMethod: "stretch"; linearRGB: true; method: "lanczos3"; premultiply: true }
      • Readonly fitMethod: "stretch"
      • Readonly linearRGB: true
      • Readonly method: "lanczos3"
      • Readonly premultiply: true
    • Readonly description: "Resize the image before compressing"
    • Readonly instantiate: () => Promise<(buffer: Uint8Array | Buffer, input_width: number, input_height: number, { width, height, method, premultiply, linearRGB, }: { height?: number; linearRGB: boolean; method: "triangle" | "catrom" | "mitchell" | "lanczos3"; premultiply: boolean; width?: number }) => default>
        • (): Promise<(buffer: Uint8Array | Buffer, input_width: number, input_height: number, { width, height, method, premultiply, linearRGB, }: { height?: number; linearRGB: boolean; method: "triangle" | "catrom" | "mitchell" | "lanczos3"; premultiply: boolean; width?: number }) => default>
        • Returns Promise<(buffer: Uint8Array | Buffer, input_width: number, input_height: number, { width, height, method, premultiply, linearRGB, }: { height?: number; linearRGB: boolean; method: "triangle" | "catrom" | "mitchell" | "lanczos3"; premultiply: boolean; width?: number }) => default>

    • Readonly name: "Resize"
  • Readonly rotate: { defaultOptions: { numRotations: 0 }; description: "Rotate image"; instantiate: () => Promise<(buffer: Uint8Array | Buffer, width: number, height: number, { numRotations }: { numRotations: number }) => Promise<default>>; name: "Rotate" }
    • Readonly defaultOptions: { numRotations: 0 }
      • Readonly numRotations: 0
    • Readonly description: "Rotate image"
    • Readonly instantiate: () => Promise<(buffer: Uint8Array | Buffer, width: number, height: number, { numRotations }: { numRotations: number }) => Promise<default>>
        • (): Promise<(buffer: Uint8Array | Buffer, width: number, height: number, { numRotations }: { numRotations: number }) => Promise<default>>
        • Returns Promise<(buffer: Uint8Array | Buffer, width: number, height: number, { numRotations }: { numRotations: number }) => Promise<default>>

    • Readonly name: "Rotate"

Generated using TypeDoc