UNPKG

1.8 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/gulp-zip`
3
4# Summary
5This package contains type definitions for gulp-zip (https://github.com/sindresorhus/gulp-zip).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-zip.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-zip/index.d.ts)
10````ts
11// Type definitions for gulp-zip 4.0
12// Project: https://github.com/sindresorhus/gulp-zip
13// Definitions by: Louis Orleans <https://github.com/dudeofawesome>
14// Robert Bullen <https://github.com/robertbullen>
15// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
16
17/// <reference types="node" />
18
19declare namespace GulpZip {
20 interface GulpZipOptions {
21 /**
22 * Compress
23 * @default true
24 */
25 compress?: boolean | undefined;
26
27 /**
28 * Overrides the modification timestamp for all files added to the archive.
29 *
30 * Tip: Setting it to the same value across executions enables you to create stable archives
31 * that change only when the contents of their entries change, regardless of whether those
32 * entries were "touched" or regenerated.
33 *
34 * @default undefined
35 */
36 modifiedTime?: Date | undefined;
37 }
38}
39
40declare function GulpZip(filename: string, options?: GulpZip.GulpZipOptions): NodeJS.ReadStream;
41
42export = GulpZip;
43
44````
45
46### Additional Details
47 * Last updated: Thu, 08 Jul 2021 14:22:36 GMT
48 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
49 * Global values: none
50
51# Credits
52These definitions were written by [Louis Orleans](https://github.com/dudeofawesome), and [Robert Bullen](https://github.com/robertbullen).
53
\No newline at end of file