Add PrettyStream constructor with options, and some doc comments

This commit is contained in:
Vadim Macagon 2015-05-28 22:37:24 +07:00
parent ed38db403a
commit f7ceda5046

View File

@ -1,6 +1,6 @@
// Type definitions for bunyan-prettystream
// Type definitions for bunyan-prettystream 0.1.3
// Project: https://www.npmjs.com/package/bunyan-prettystream
// Definitions by: Jason Swearingen <https://github.com/jasonswearingen/>
// Definitions by: Jason Swearingen <https://github.com/jasonswearingen/>, Vadim Macagon <https://github.com/enlight/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../node/node.d.ts" />
@ -8,7 +8,23 @@
declare module "bunyan-prettystream" {
import stream = require("stream");
class PrettyStream extends stream.Writable {
public pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T;
/**
* @param options.mode Output format, can be either `long`, `short`, or `dev`,
* defaults to `long`.
* @param options.useColor Indicates whether or not output should be colored,
* defaults to `true`.
*/
constructor(options?: { mode?: string; useColor?: boolean });
/**
* Pipes data from this stream to another.
*
* @param destination Stream to write data to.
* @param options.end Indicates whether `end()` should be called on the `destination`
* stream when this stream emits `end`, defaults to `true`.
* @return The `destination` stream.
*/
pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T;
}
export = PrettyStream;
}