mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-21 21:31:12 +08:00
55d9114bbd
* [through2] Fix typos * [through2] Change return types to stream.Transform `through2` creates `stream.Transform`-flavored streams, so switching the return types to `stream.Transform` gives us richer typing information than using `NodeJS.ReadWriteStream`, which is missing methods (e.g. `stream.Transform#push`) and the ability to use object mode. * [through2] Add through2.ctor method * [through2] Update header and docs
41 lines
1.5 KiB
TypeScript
41 lines
1.5 KiB
TypeScript
// Type definitions for through2 v 2.0.0
|
|
// Project: https://github.com/rvagg/through2
|
|
// Definitions by: Bart van der Schoor <https://github.com/Bartvds>, jedmao <https://github.com/jedmao>, Georgios Valotasios <https://github.com/valotas>, Ben Chauvette <https://github.com/bdchauvette>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference path="../node/node.d.ts" />
|
|
|
|
declare module 'through2' {
|
|
|
|
import stream = require('stream');
|
|
|
|
type TransformCallback = (err?: any, data?: any) => void;
|
|
type TransformFunction = (chunk: any, enc: string, callback: TransformCallback) => void;
|
|
type FlushCallback = (flushCallback: () => void) => void;
|
|
|
|
function through2(transform?: TransformFunction, flush?: FlushCallback): stream.Transform;
|
|
|
|
function through2(opts?: stream.DuplexOptions, transform?: TransformFunction, flush?: FlushCallback): stream.Transform;
|
|
|
|
namespace through2 {
|
|
export interface Through2Constructor extends stream.Transform {
|
|
new(opts?: stream.DuplexOptions): stream.Transform;
|
|
(opts?: stream.DuplexOptions): stream.Transform;
|
|
}
|
|
|
|
/**
|
|
* Convenvience method for creating object streams
|
|
*/
|
|
export function obj(transform?: TransformFunction, flush?: FlushCallback): stream.Transform;
|
|
|
|
/**
|
|
* Creates a constructor for a custom Transform. This is useful when you
|
|
* want to use the same transform logic in multiple instances.
|
|
*/
|
|
export function ctor(opts?: stream.DuplexOptions, transfrom?: TransformFunction, flush?: FlushCallback): Through2Constructor;
|
|
}
|
|
|
|
export = through2;
|
|
|
|
}
|