@types/gulp-changed
Version:
TypeScript definitions for gulp-changed
72 lines (56 loc) • 2.21 kB
Markdown
# Installation
> `npm install --save @types/gulp-changed`
# Summary
This package contains type definitions for gulp-changed (https://github.com/sindresorhus/gulp-changed).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-changed.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-changed/index.d.ts)
````ts
/// <reference types="node"/>
/// <reference types="vinyl" />
import { Transform } from "stream";
import File = require("vinyl");
interface IComparator {
/**
* @param stream Should be used to queue sourceFile if it passes some comparison
* @param sourceFile File to operate on
* @param destPath Destination for sourceFile as an absolute path
*/
(stream: Transform, sourceFile: File, destPath: string): void;
}
interface IDestination {
(file: string | Buffer): string;
}
interface IOptions {
/**
* The working directory the folder is relative to.
* @default process.cwd()
*/
cwd?: string | undefined;
/**
* Extension of the destination files.
*/
extension?: string | undefined;
/**
* Function that determines whether the source file is different from the destination file.
* @default changed.compareLastModifiedTime
*/
hasChanged?: IComparator | undefined;
/**
* Function to transform the path to the destination file. Should return the absolute path to the (renamed) destination file.
*/
transformPath?: ((destPath: string) => string) | undefined;
}
interface IGulpChanged {
(destination: string | IDestination, options?: IOptions): NodeJS.ReadWriteStream;
compareLastModifiedTime: IComparator;
compareContents: IComparator;
}
declare const changed: IGulpChanged;
export = changed;
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 03:09:37 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/vinyl](https://npmjs.com/package/@types/vinyl)
# Credits
These definitions were written by [Thomas Corbière](https://github.com/tomc974), and [Jordy van Dortmont](https://github.com/jordyvandortmont).