UNPKG

1.69 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/gulp-filter`
3
4# Summary
5This package contains type definitions for gulp-filter (https://github.com/sindresorhus/gulp-filter).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-filter.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-filter/index.d.ts)
10````ts
11// Type definitions for gulp-filter v3.0.1
12// Project: https://github.com/sindresorhus/gulp-filter
13// Definitions by: Tanguy Krotoff <https://github.com/tkrotoff>
14// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
15// TypeScript Version: 2.2
16
17/// <reference types="node" />
18
19import File = require('vinyl');
20import * as Minimatch from 'minimatch';
21
22declare namespace filter {
23 interface FileFunction {
24 (file: File): boolean;
25 }
26
27 interface Options extends Minimatch.IOptions {
28 restore?: boolean | undefined;
29 passthrough?: boolean | undefined;
30 }
31
32 // A transform stream with a .restore object
33 interface Filter extends NodeJS.ReadWriteStream {
34 restore: NodeJS.ReadWriteStream
35 }
36}
37
38declare function filter(pattern: string | string[] | filter.FileFunction, options?: filter.Options): filter.Filter;
39
40export = filter;
41
42````
43
44### Additional Details
45 * Last updated: Fri, 20 Jan 2023 10:02:36 GMT
46 * Dependencies: [@types/minimatch](https://npmjs.com/package/@types/minimatch), [@types/node](https://npmjs.com/package/@types/node), [@types/vinyl](https://npmjs.com/package/@types/vinyl)
47 * Global values: none
48
49# Credits
50These definitions were written by [Tanguy Krotoff](https://github.com/tkrotoff).
51
\No newline at end of file