UNPKG

1.52 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/pumpify`
3
4# Summary
5This package contains type definitions for pumpify (https://github.com/mafintosh/pumpify).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pumpify.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pumpify/index.d.ts)
10````ts
11/// <reference types="node" />
12
13import * as duplexify from "duplexify";
14import { Duplex, Readable, Stream, Writable } from "stream";
15
16declare class Pumpify extends Duplex implements duplexify.Duplexify {
17 constructor(...streams: Stream[]);
18 constructor(streams: Stream[]);
19 setPipeline(...streams: Stream[]): void;
20 setPipeline(streams: Stream[]): void;
21
22 // Duplexify members
23 setWritable(writable: Writable): void;
24 setReadable(readable: Readable): void;
25}
26
27interface PumpifyFactoryOptions {
28 autoDestroy: boolean;
29 destroy: boolean;
30 objectMode: boolean;
31 highWaterMark: number;
32}
33
34declare namespace Pumpify {
35 let obj: typeof Pumpify;
36 function ctor(opts: PumpifyFactoryOptions): typeof Pumpify;
37}
38
39export = Pumpify;
40
41````
42
43### Additional Details
44 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
45 * Dependencies: [@types/duplexify](https://npmjs.com/package/@types/duplexify), [@types/node](https://npmjs.com/package/@types/node)
46
47# Credits
48These definitions were written by [Justin Beckwith](https://github.com/JustinBeckwith), and [Ankur Oberoi](https://github.com/aoberoi).
49
\No newline at end of file