@types/gulp-sort
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    Installation

    npm install --save @types/gulp-sort

    Summary

    This package contains type definitions for gulp-sort (https://github.com/pgilad/gulp-sort).

    Details

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

    index.d.ts

    // Type definitions for gulp-sort 2.0
    // Project: https://github.com/pgilad/gulp-sort
    // Definitions by: Joe Skeen <https://github.com/joeskeen>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    
    /// <reference types="node" />
    
    /** Sort files in stream by path or any custom sort comparator */
    
    import gulpUtil = require('gulp-util');
    
    interface IOptions {
        /**
         * A function to compare two files.
         * Returns:
         * -1 if file1 should be before file2,
         * 0 if file1 is equivalent to file2, and
         * 1 if file1 should be after file2
         */
        comparator?: IComparatorFunction | undefined;
        /** Whether to sort in ascending order, default is true */
        asc?: boolean | undefined;
        /** Whether to use a custom sort function. */
        customSortFn?: (files: gulpUtil.File[], comparator?: IComparatorFunction) => gulpUtil.File[];
    }
    
    interface IComparatorFunction {
        /**
         * A function to compare two files.
         * Returns:
         * -1 if file1 should be before file2,
         * 0 if file1 is equivalent to file2, and
         * 1 if file1 should be after file2
         */
        (file1: gulpUtil.File, file2: gulpUtil.File): number;
    }
    
    /** Sort files in stream by path or any custom sort comparator */
    declare function gulpSort(): NodeJS.ReadWriteStream;
    declare function gulpSort(comparator: IComparatorFunction): NodeJS.ReadWriteStream;
    declare function gulpSort(options: IOptions): NodeJS.ReadWriteStream;
    
    declare namespace gulpSort {}
    
    export = gulpSort;

    Additional Details

    Credits

    These definitions were written by Joe Skeen.

    Keywords

    none

    Install

    npm i @types/gulp-sort

    DownloadsWeekly Downloads

    3,652

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    5.7 kB

    Total Files

    4

    Last publish

    Collaborators

    • types