Interface NodeJS.ReadableStream

Extends

Properties

P readable: boolean

Type:
  • boolean

Methods

M addListener(event: string, listener: function) NodeJS.EventEmitter

Parameters:
Name Type
event string
listener function
Inherited From:
Returns: { NodeJS.EventEmitter }

M emit(event: string, ...args: any) boolean

Parameters:
Name Type Argument
event string
...args any <repeatable>
Inherited From:
Returns: { boolean }

M listeners(event: string) function()[]

Parameters:
Name Type
event string
Inherited From:
Returns: { Array.<function()> }

M on(event: string, listener: function) NodeJS.EventEmitter

Parameters:
Name Type
event string
listener function
Inherited From:
Returns: { NodeJS.EventEmitter }

M once(event: string, listener: function) NodeJS.EventEmitter

Parameters:
Name Type
event string
listener function
Inherited From:
Returns: { NodeJS.EventEmitter }

M pause() void

Returns: { void }

M pipe<T>(destination: T, options: NodeJS.ReadableStream.PipeOptionsType) T

Parameters:
Name Type Argument
destination T
options NodeJS.ReadableStream.PipeOptionsType <optional>
Returns: { T }

M read(size: number) string|Buffer

Parameters:
Name Type Argument
size number <optional>
Returns: { string | Buffer }

M removeAllListeners(event: string) NodeJS.EventEmitter

Parameters:
Name Type Argument
event string <optional>
Inherited From:
Returns: { NodeJS.EventEmitter }

M removeListener(event: string, listener: function) NodeJS.EventEmitter

Parameters:
Name Type
event string
listener function
Inherited From:
Returns: { NodeJS.EventEmitter }

M resume() void

Returns: { void }

M setEncoding(encoding: string) void

Parameters:
Name Type
encoding string
Returns: { void }

M setMaxListeners(n: number) void

Parameters:
Name Type
n number
Inherited From:
Returns: { void }

M unpipe<T>(destination: T) void

Parameters:
Name Type Argument
destination T <optional>
Returns: { void }

M unshift(chunk: string) void

Parameters:
Name Type
chunk string
Returns: { void }

M unshift(chunk: Buffer) void

Parameters:
Name Type
chunk Buffer
Returns: { void }

M wrap(oldStream: NodeJS.ReadableStream) NodeJS.ReadableStream

Parameters:
Name Type
oldStream NodeJS.ReadableStream
Returns: { NodeJS.ReadableStream }

Type Definitions

T PipeOptionsType

Type:
  • Object
Properties:
Name Type
end boolean