UNPKG

1.47 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/gulp-rename`
3
4# Summary
5This package contains type definitions for gulp-rename (https://github.com/hparra/gulp-rename).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-rename.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-rename/index.d.ts)
10````ts
11/// <reference types="node"/>
12import * as File from "vinyl";
13
14declare namespace rename {
15 interface ParsedPath {
16 dirname: string;
17 basename: string;
18 extname: string;
19 }
20
21 interface Options {
22 dirname?: string | undefined;
23 basename?: string | undefined;
24 extname?: string | undefined;
25 prefix?: string | undefined;
26 suffix?: string | undefined;
27 }
28
29 interface PluginOptions {
30 multiExt?: boolean | undefined;
31 }
32}
33
34declare function rename(
35 // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
36 obj: string | rename.Options | ((path: rename.ParsedPath, file: File) => rename.ParsedPath | void),
37 options?: rename.PluginOptions,
38): NodeJS.ReadWriteStream;
39export = rename;
40
41````
42
43### Additional Details
44 * Last updated: Wed, 22 Nov 2023 00:24:48 GMT
45 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/vinyl](https://npmjs.com/package/@types/vinyl)
46
47# Credits
48These definitions were written by [Asana](https://asana.com).
49
\No newline at end of file