IReadable

js.node.stream.IReadable (extern interface)

IReadable interface is used as "any Readable".

See Readable for actual class documentation.

Instance Members

destroyed: Bool

readable: Bool

readableEncoding: Null<String>

readableEnded: Bool

readableHighWaterMark: Int

readableLength: Int

readableObjectMode: Bool

destroy(?error: js.lib.Error): IReadable

Name	Type	Default
`error`	js.lib.Error	(optional)

Returns
IReadable

isPaused(): Bool

Returns
Bool

pause(): IReadable

Returns
IReadable

pipe(destination: pipe.T, ?options: AnonStruct): pipe.T

Name	Type	Default
`destination`	pipe.T
`options`	AnonStruct	(optional)

Returns
pipe.T

read(?size: Int): Null<Dynamic>

Name	Type	Default
`size`	Int	(optional)

Returns
Null<Dynamic>

resume(): IReadable

Returns
IReadable

setEncoding(encoding: String): IReadable

Name	Type
`encoding`	String

Returns
IReadable

unpipe(?destination: IWritable): IReadable

Name	Type	Default
`destination`	IWritable	(optional)

Returns
IReadable

unshift(chunk: Null<Dynamic>, ?encoding: String): Void

Name	Type	Default
`chunk`	Null<Dynamic>
`encoding`	String	(optional)

wrap(stream: Dynamic): IReadable

Name	Type
`stream`	Dynamic

Returns
IReadable

Name	Parameters
`:remove`	-