SutroStream | sutro

Hierarchy

Readable
- SutroStream

Index

Properties

Optional contentType

contentType: string

destroyed

destroyed: boolean

readable

readable: boolean

Readonly readableEncoding

readableEncoding: BufferEncoding

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterableIterator<any>

Inherited from Readable.__@asyncIterator
- Defined in node_modules/@types/node/stream.d.ts:129
Returns AsyncIterableIterator<any>

_destroy

_destroy(error: Error, callback: (error?: Error) => void): void

Inherited from Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:52
Parameters
- error: Error
- callback: (error?: Error) => void
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

_read

_read(size: number): void

Inherited from Readable._read
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- size: number
Returns void

addListener

addListener(event: "close", listener: () => void): SutroStream
addListener(event: "data", listener: (chunk: any) => void): SutroStream
addListener(event: "end", listener: () => void): SutroStream
addListener(event: "error", listener: (err: Error) => void): SutroStream
addListener(event: "pause", listener: () => void): SutroStream
addListener(event: "readable", listener: () => void): SutroStream
addListener(event: "resume", listener: () => void): SutroStream
addListener(event: string | symbol, listener: (...args: any[]) => void): SutroStream

Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:66
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. error
5. pause
6. readable
7. resume
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:67
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns SutroStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:68
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:69
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns SutroStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:70
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:72
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SutroStream

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in node_modules/@types/node/stream.d.ts:53
Parameters
- Optional error: Error
Returns void

emit

emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "error", err: Error): boolean
emit(event: "pause"): boolean
emit(event: "readable"): boolean
emit(event: "resume"): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:76
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:77
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:78
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:79
Parameters
- event: "pause"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:80
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:81
Parameters
- event: "resume"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:82
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from Readable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from Readable.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in node_modules/@types/node/stream.d.ts:47
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from Readable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from Readable.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): SutroStream

Inherited from Readable.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SutroStream

on

on(event: "close", listener: () => void): SutroStream
on(event: "data", listener: (chunk: any) => void): SutroStream
on(event: "end", listener: () => void): SutroStream
on(event: "error", listener: (err: Error) => void): SutroStream
on(event: "pause", listener: () => void): SutroStream
on(event: "readable", listener: () => void): SutroStream
on(event: "resume", listener: () => void): SutroStream
on(event: string | symbol, listener: (...args: any[]) => void): SutroStream

Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:84
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:85
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns SutroStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:86
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:87
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns SutroStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:89
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:90
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:91
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SutroStream

once

once(event: "close", listener: () => void): SutroStream
once(event: "data", listener: (chunk: any) => void): SutroStream
once(event: "end", listener: () => void): SutroStream
once(event: "error", listener: (err: Error) => void): SutroStream
once(event: "pause", listener: () => void): SutroStream
once(event: "readable", listener: () => void): SutroStream
once(event: "resume", listener: () => void): SutroStream
once(event: string | symbol, listener: (...args: any[]) => void): SutroStream

Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:93
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:94
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns SutroStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:95
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:96
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns SutroStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:98
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:100
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SutroStream

pause

pause(): SutroStream

Inherited from Readable.pause
- Defined in node_modules/@types/node/stream.d.ts:45
Returns SutroStream

pipe

pipe<T>(destination: T, options?: { end?: boolean }): T

Inherited from Readable.pipe
- Defined in node_modules/@types/node/stream.d.ts:10
Type parameters
- T: WritableStream<T>
Parameters
- destination: T
- Optional options: { end?: boolean }
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: "close", listener: () => void): SutroStream
prependListener(event: "data", listener: (chunk: any) => void): SutroStream
prependListener(event: "end", listener: () => void): SutroStream
prependListener(event: "error", listener: (err: Error) => void): SutroStream
prependListener(event: "pause", listener: () => void): SutroStream
prependListener(event: "readable", listener: () => void): SutroStream
prependListener(event: "resume", listener: () => void): SutroStream
prependListener(event: string | symbol, listener: (...args: any[]) => void): SutroStream

Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:102
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:103
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns SutroStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:104
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:105
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns SutroStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:106
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:107
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:108
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:109
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SutroStream

prependOnceListener

prependOnceListener(event: "close", listener: () => void): SutroStream
prependOnceListener(event: "data", listener: (chunk: any) => void): SutroStream
prependOnceListener(event: "end", listener: () => void): SutroStream
prependOnceListener(event: "error", listener: (err: Error) => void): SutroStream
prependOnceListener(event: "pause", listener: () => void): SutroStream
prependOnceListener(event: "readable", listener: () => void): SutroStream
prependOnceListener(event: "resume", listener: () => void): SutroStream
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): SutroStream

Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:111
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:112
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns SutroStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:113
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:114
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns SutroStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:115
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:116
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:117
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:118
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SutroStream

push

push(chunk: any, encoding?: BufferEncoding): boolean

Inherited from Readable.push
- Defined in node_modules/@types/node/stream.d.ts:51
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns boolean

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from Readable.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: number): any

Inherited from Readable.read
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- Optional size: number
Returns any

removeAllListeners

removeAllListeners(event?: string | symbol): SutroStream

Inherited from Readable.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns SutroStream

removeListener

removeListener(event: "close", listener: () => void): SutroStream
removeListener(event: "data", listener: (chunk: any) => void): SutroStream
removeListener(event: "end", listener: () => void): SutroStream
removeListener(event: "error", listener: (err: Error) => void): SutroStream
removeListener(event: "pause", listener: () => void): SutroStream
removeListener(event: "readable", listener: () => void): SutroStream
removeListener(event: "resume", listener: () => void): SutroStream
removeListener(event: string | symbol, listener: (...args: any[]) => void): SutroStream

Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:120
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:121
Parameters
- event: "data"
- listener: (chunk: any) => void
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns SutroStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122
Parameters
- event: "end"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:123
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns SutroStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:124
Parameters
- event: "pause"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:125
Parameters
- event: "readable"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:126
Parameters
- event: "resume"
- listener: () => void
  - - (): void
    - Returns void
Returns SutroStream
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:127
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SutroStream

resume

resume(): SutroStream

Inherited from Readable.resume
- Defined in node_modules/@types/node/stream.d.ts:46
Returns SutroStream

setEncoding

setEncoding(encoding: BufferEncoding): SutroStream

Inherited from Readable.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:44
Parameters
- encoding: BufferEncoding
Returns SutroStream

setMaxListeners

setMaxListeners(n: number): SutroStream

Inherited from Readable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns SutroStream

unpipe

unpipe(destination?: WritableStream): SutroStream

Inherited from Readable.unpipe
- Defined in node_modules/@types/node/stream.d.ts:48
Parameters
- Optional destination: WritableStream
Returns SutroStream

unshift

unshift(chunk: any, encoding?: BufferEncoding): void

Inherited from Readable.unshift
- Defined in node_modules/@types/node/stream.d.ts:49
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void

wrap

wrap(oldStream: ReadableStream): SutroStream

Inherited from Readable.wrap
- Defined in node_modules/@types/node/stream.d.ts:50
Parameters
- oldStream: ReadableStream
Returns SutroStream

Generated using TypeDoc

Hierarchy

Index

Properties

Methods

Properties

Optional contentType

destroyed

readable

Readonly readableEncoding

Readonly readableEnded

Readonly readableFlowing

Readonly readableHighWaterMark

Readonly readableLength

Readonly readableObjectMode

Methods

[Symbol.asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error

callback: (error?: Error) => void

Parameters

Optional error: Error

Returns void

Returns void

_read

Parameters

size: number

Returns void

addListener

Parameters

event: "close"

listener: () => void

Returns void

Returns SutroStream

Parameters

event: "data"

listener: (chunk: any) => void

Parameters

chunk: any

Returns void

Returns SutroStream

Parameters

event: "end"

listener: () => void

Returns void

Returns SutroStream

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns SutroStream

Parameters

event: "pause"

listener: () => void

Returns void

Returns SutroStream

Parameters

event: "readable"

listener: () => void

Returns void

Returns SutroStream

Parameters

event: "resume"

listener: () => void

Returns void

Returns SutroStream

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns SutroStream

destroy

Parameters

Optional error: Error

Returns void