Options
All
  • Public
  • Public/Protected
  • All
Menu

@ezy/webp

Index

Variables

Functions

Variables

Const LIB_PATH

LIB_PATH: string = path.join(PACKAGE_PATH, 'lib')

Const PACKAGE_PATH

PACKAGE_PATH: string = path.join(__dirname, '..', '..')

Const config

config: any = packageJson[packageJson.name]

Const currentPlatform

currentPlatform: string = process.platform === 'darwin'? platforms[0]: process.platform === 'linux'? platforms[1]: process.platform === 'win32'? process.arch === 'x64'? platforms[2]: platforms[3]: 'unsupported'

Const packageJson

packageJson: any = require(path.join(PACKAGE_PATH, 'package.json'))

Const platforms

platforms: string[] = ['mac-10.14','linux-x86-64','windows-x64','windows-x86']

Functions

createExecuteCallback

  • createExecuteCallback(resolve: function, reject: function): (Anonymous function)

  • Parameters

    • resolve: function
        • (result: string): void

        • Parameters

          • result: string

          Returns void

    • reject: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns (Anonymous function)

cwebp

  • cwebp(input: string, output: string, ...options: string[]): Promise<string>

  • Description

    compresses an image using the WebP format. Input format can be either PNG, JPEG, TIFF, WebP or raw Y'CbCr samples.

    Examples

     
    await cwebp('me.jpg', 'me.webp')
await cwebp('me.jpg', 'me.webp', '-lossless')
await cwebp('me.jpg', 'me.webp', '-q', '50')

    Params

    Parameters

    Returns Promise<string>

dwebp

  • dwebp(input: string, output: string, ...options: string[]): Promise<string>

execute

  • execute(name: string, options: string[]): Promise<string>
  • execute(name: string, options: string[], cb: function): void

  • Description

    Call a libwebp binary

    Examples

    using promise

     
    await execute('cwebp', ['-version'])

    using node-callback

     
    execute('cwebp', ['-version'], (err, version) => err? console.error(err) : console.log(version))

    Parameters

    • name: string

      name of the libwebp bin to execute

    • options: string[]

      list of options to pass to the libwebp bin

    Returns Promise<string>

  • Parameters

    • name: string
    • options: string[]
    • cb: function
        • (err: Error | void, result?: string): void

        • Parameters

          • err: Error | void
          • Optional result: string

          Returns void

    Returns void

getBin

  • getBin(name: string): string

gif2webp

  • gif2webp(input: string, output: string, ...options: string[]): Promise<string>

Generated using TypeDoc