forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gulp-sort.d.ts
46 lines (38 loc) · 1.31 KB
/
gulp-sort.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// Type definitions for gulp-sort
// Project: https://github.com/pgilad/gulp-sort
// Definitions by: Joe Skeen <http://github.com/joeskeen>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../node/node.d.ts" />
/// <reference path="../gulp-util/gulp-util.d.ts" />
/** Sort files in stream by path or any custom sort comparator */
declare module 'gulp-sort' {
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;
/** Whether to sort in ascending order, default is true */
asc?: boolean;
}
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 */
function gulpSort(): NodeJS.ReadWriteStream;
function gulpSort(comparator: IComparatorFunction): NodeJS.ReadWriteStream;
function gulpSort(options: IOptions): NodeJS.ReadWriteStream;
namespace gulpSort {}
export = gulpSort;
}