@types/gulp-responsive-images

TypeScript definitions for gulp-responsive-images

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
34,991792Jul 28, 2021Oct 5, 2012Minified + gzip package size for @types/gulp-responsive-images in KB

Readme

Installation

npm install --save @types/gulp-responsive-images

Summary

This package contains type definitions for gulp-responsive-images (https://github.com/dcgauld/gulp-responsive-images#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-responsive-images.

index.d.ts

// Type definitions for gulp-responsive-images 0.0
// Project: https://github.com/dcgauld/gulp-responsive-images#readme
// Definitions by: Aankhen <https://github.com/aankhen>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

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

import * as stream from "stream";
import * as gm from "gm";
import { ParsedPath, Options as RenameOptions } from "gulp-rename";

export = GulpResponsiveImage;

declare function GulpResponsiveImage(configs: GulpResponsiveImage.Matchers): stream.Transform;

declare namespace GulpResponsiveImage {
    type SamplingFactor = [number, number];

    type Rename = string
        | ((path: ParsedPath) => any)
        | RenameOptions;

    interface Settings {
        crop?: boolean | undefined;
        format?: string | undefined;
        gravity?: gm.GravityDirection | undefined;
        overwrite?: boolean | undefined;
        quality?: number | undefined;
        rename?: Rename | undefined;
        percentage?: number | undefined;
        sharpen?: boolean | undefined;
        upscale?: boolean | undefined;
        filter?: gm.FilterType | undefined;
        height?: number | undefined;
        width?: number | undefined;
        samplingFactor?: SamplingFactor | undefined;
        suffix?: string | undefined;
    }

    interface Matchers {
        [index: string]: ReadonlyArray<Settings>;
    }
}

Additional Details

Credits

These definitions were written by Aankhen.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.