Interface fs.ReadStream

Extends

Properties

P readable: boolean

Type:
  • boolean
Inherited From:

Methods

M _read(size: number) void

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

M pause() void

Inherited From:
Returns: { void }

M pipe<T>(destination: T, options: stream.Readable.PipeOptionsType) T

Parameters:
Name Type Argument
destination T
options stream.Readable.PipeOptionsType <optional>
Inherited From:
Returns: { T }

M push(chunk: any, encoding: string) boolean

Parameters:
Name Type Argument
chunk any
encoding string <optional>
Inherited From:
Returns: { boolean }

M read(size: number) string|Buffer

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

M resume() void

Inherited From:
Returns: { void }

M setEncoding(encoding: string) void

Parameters:
Name Type
encoding string
Inherited From:
Returns: { void }

M unpipe<T>(destination: T) void

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

M unshift(chunk: string) void

Parameters:
Name Type
chunk string
Inherited From:
Returns: { void }

M unshift(chunk: Buffer) void

Parameters:
Name Type
chunk Buffer
Inherited From:
Returns: { void }

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

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