@types/gulp-watch
Version:
TypeScript definitions for gulp-watch
52 lines (40 loc) • 1.91 kB
Markdown
# Installation
> `npm install --save @types/gulp-watch`
# Summary
This package contains type definitions for gulp-watch (https://github.com/floatdrop/gulp-watch).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-watch.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-watch/index.d.ts)
````ts
// Type definitions for gulp-watch v4.1.1
// Project: https://github.com/floatdrop/gulp-watch
// Definitions by: Tanguy Krotoff <https://github.com/tkrotoff>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference types="node" />
import * as File from "vinyl";
import { SrcOptions } from "vinyl-fs";
interface IOptions extends SrcOptions {
ignoreInitial?: boolean | undefined;
events?: Array<string> | undefined;
base?: string | undefined;
name?: string | undefined;
verbose?: boolean | undefined;
readDelay?: number | undefined;
}
interface IWatchStream extends NodeJS.ReadWriteStream {
add(path: string | Array<string>): NodeJS.ReadWriteStream;
unwatch(path: string | Array<string>): NodeJS.ReadWriteStream;
close(): NodeJS.ReadWriteStream;
}
type Cb = (file: File & { event: "add" | "change" | "unlink" }) => void;
declare function watch(glob: string | Array<string>, callback?: Cb): IWatchStream;
declare function watch(glob: string | Array<string>, options?: IOptions, callback?: Cb): IWatchStream;
declare namespace watch {}
export = watch;
````
### Additional Details
* Last updated: Wed, 20 Sep 2023 17:08:03 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/vinyl](https://npmjs.com/package/@types/vinyl), [@types/vinyl-fs](https://npmjs.com/package/@types/vinyl-fs)
* Global values: none
# Credits
These definitions were written by [Tanguy Krotoff](https://github.com/tkrotoff).