npm.io
9.0.1 • Published 1 year ago

@types/imagemin

Licence
MIT
Version
9.0.1
Deps
1
Size
4 kB
Vulns
0
Weekly
0
Stars
51.4K

Installation

npm install --save @types/imagemin

Summary

This package contains type definitions for imagemin (https://github.com/imagemin/imagemin#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/imagemin.

index.d.ts

/// <reference types="node" />

/**
 * @async
 */
declare function imagemin(input: readonly string[], options?: Options): Promise<Result[]>;

declare namespace imagemin {
    /**
     * @async
     */
    function buffer(data: Uint8Array, options?: BufferOptions): Promise<Uint8Array>;
}

export type Plugin = (input: Uint8Array) => Promise<Uint8Array>;

export interface Options {
    destination?: string | undefined;
    plugins: readonly Plugin[];
    glob?: boolean | undefined;
}

export interface Result {
    data: Uint8Array;
    sourcePath: string;
    destinationPath: string;
}

export interface BufferOptions {
    plugins: readonly Plugin[];
}

export default imagemin;

Additional Details

  • Last updated: Fri, 17 Jan 2025 1326 GMT
  • Dependencies: @types/node

Credits

These definitions were written by Romain Faust, and Jeff Chan.