UNPKG

3.39 kBTypeScriptView Raw
1import {ReadStream, WriteStream} from 'fs'
2
3type sourceType = string | Buffer | ReadStream;
4
5type destType = string | WriteStream;
6
7type streamEntryOpts = {
8 relativePath?: string;
9 ignoreBase?: boolean;
10 size?: number;
11}
12
13
14export namespace gzip {
15
16 function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
17
18 function uncompress(source: sourceType, dest: destType, opts?: any): Promise<void>;
19
20 export class FileStream {
21
22 constructor(opts?: {
23 zlib?: object,
24 source: sourceType
25 });
26
27 }
28
29 export class UncompressStream {
30
31 constructor(opts?: {
32 zlib?: object,
33 source: sourceType
34 });
35
36 on(event: 'error', cb: Function): void
37
38 }
39
40}
41
42export namespace tar {
43
44 function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
45
46 function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>;
47
48 function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>;
49
50 export class Stream {
51
52 constructor();
53
54 addEntry(entry: string, opts?: streamEntryOpts): void;
55
56 addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts): void;
57 }
58
59 export class FileStream {
60
61 constructor(opts?: {
62 relativePath?: string,
63 size?: number,
64 suppressSizeWarning?: boolean,
65 source?: sourceType
66 });
67
68 }
69
70 export class UncompressStream {
71
72 constructor(opts?: {
73 source: sourceType
74 });
75
76
77 on(event: 'error', cb: Function): void
78
79 }
80
81}
82
83export namespace tgz {
84
85 function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
86
87 function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>;
88
89 function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>;
90
91 export class Stream {
92
93 constructor();
94
95 addEntry(entry: string, opts?: streamEntryOpts): void;
96
97 addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts): void;
98 }
99
100 export class FileStream {
101
102 constructor(opts?: {
103 relativePath?: string,
104 size?: number,
105 suppressSizeWarning?: boolean,
106 zlib?: object,
107 source?: sourceType
108 });
109
110 }
111
112 export class UncompressStream {
113
114 constructor(opts?: {
115 source?: sourceType,
116 strip?: number
117 });
118
119 on(event: 'entry' | 'finish' | 'error', cb: Function): void
120
121 }
122
123}
124
125export namespace zip {
126
127 function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
128
129 function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>;
130
131 function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>;
132
133 export class Stream {
134
135 constructor();
136
137 addEntry(entry: string, opts?: streamEntryOpts): void;
138
139 addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts): void;
140 }
141
142 export class FileStream {
143
144 /**
145 * If opts.source is a file path, opts.relativePath is optional, otherwise it's required.
146 *
147 * @param opts
148 */
149 constructor(opts?: {
150 relativePath?: string,
151 yazl?: Object,
152 source: string
153 } | {
154 relativePath: string,
155 yazl?: Object,
156 source?: Buffer | ReadStream
157 });
158
159 }
160
161 export class UncompressStream {
162
163 constructor(opts?: {
164 source?: sourceType,
165 strip?: number
166 });
167
168 on(event: 'entry' | 'finish' | 'error', cb: Function): void
169
170 }
171
172}
173