Http2Stream | typescript

Hierarchy

Duplex
- Http2Stream
  - ClientHttp2Stream
  - ServerHttp2Stream

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new Http2Stream(opts?: DuplexOptions): Http2Stream

Inherited from Duplex.constructor

Overrides Readable.constructor
- Defined in node_modules/@types/node/stream.d.ts:258
Parameters
- Optional opts: DuplexOptions
Returns Http2Stream

Properties

aborted

aborted: boolean

bufferSize

bufferSize: number

closed

closed: boolean

destroyed

destroyed: boolean

endAfterHeaders

endAfterHeaders: boolean

Set the true if the END_STREAM flag was set in the request or response HEADERS frame received, indicating that no additional data should be received and the readable side of the Http2Stream will be closed.

Optional id

id: number

pending

pending: boolean

readable

readable: boolean

readableEncoding

readableEncoding: BufferEncoding | null

readableEnded

readableEnded: boolean

readableFlowing

readableFlowing: boolean | null

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

readableObjectMode

readableObjectMode: boolean

rstCode

rstCode: number

writable

writable: boolean

writableCorked

writableCorked: number

writableEnded

writableEnded: boolean

writableFinished

writableFinished: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

writableObjectMode

writableObjectMode: boolean

Methods

[Symbol.asyncIterator]

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

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

_destroy

_destroy(error: Error | null, callback: function): void

Inherited from Duplex._destroy

Overrides Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:262
Parameters
- error: Error | null
- callback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns void

_final

_final(callback: function): void

Inherited from Duplex._final
- Defined in node_modules/@types/node/stream.d.ts:263
Parameters
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      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

_write

_write(chunk: any, encoding: BufferEncoding, callback: function): void

Inherited from Duplex._write
- Defined in node_modules/@types/node/stream.d.ts:260
Parameters
- chunk: any
- encoding: BufferEncoding
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

Optional _writev

_writev(chunks: Array<object>, callback: function): void

Inherited from Duplex._writev
- Defined in node_modules/@types/node/stream.d.ts:261
Parameters
- chunks: Array<object>
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: "aborted", listener: function): this
addListener(event: "close", listener: function): this
addListener(event: "data", listener: function): this
addListener(event: "drain", listener: function): this
addListener(event: "end", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "finish", listener: function): this
addListener(event: "frameError", listener: function): this
addListener(event: "pipe", listener: function): this
addListener(event: "unpipe", listener: function): this
addListener(event: "streamClosed", listener: function): this
addListener(event: "timeout", listener: function): this
addListener(event: "trailers", listener: function): this
addListener(event: "wantTrailers", listener: function): this
addListener(event: string | symbol, listener: function): this

Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:95
Parameters
- event: "aborted"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:96
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:97
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:98
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:99
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:100
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:101
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:102
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:103
Parameters
- event: "pipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:104
Parameters
- event: "unpipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:105
Parameters
- event: "streamClosed"
- listener: function
  - - (code: number): void
    - Parameters
      - code: number
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:106
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:107
Parameters
- event: "trailers"
- listener: function
  - - (trailers: IncomingHttpHeaders, flags: number): void
    - Parameters
      - trailers: IncomingHttpHeaders
      - flags: number
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:108
Parameters
- event: "wantTrailers"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/http2.d.ts:109
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(code?: number, callback?: function): void

- Defined in node_modules/@types/node/http2.d.ts:90
Parameters
- Optional code: number
- Optional callback: function
  - - (): void
    - Returns void
Returns void

cork

cork(): void

Inherited from Duplex.cork
- Defined in node_modules/@types/node/stream.d.ts:270
Returns void

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: "aborted"): boolean
emit(event: "close"): boolean
emit(event: "data", chunk: Buffer | string): boolean
emit(event: "drain"): boolean
emit(event: "end"): boolean
emit(event: "error", err: Error): boolean
emit(event: "finish"): boolean
emit(event: "frameError", frameType: number, errorCode: number): boolean
emit(event: "pipe", src: stream.Readable): boolean
emit(event: "unpipe", src: stream.Readable): boolean
emit(event: "streamClosed", code: number): boolean
emit(event: "timeout"): boolean
emit(event: "trailers", trailers: IncomingHttpHeaders, flags: number): boolean
emit(event: "wantTrailers"): boolean
emit(event: string | symbol, ...args: any[]): boolean

Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:111
Parameters
- event: "aborted"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:112
Parameters
- event: "close"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:113
Parameters
- event: "data"
- chunk: Buffer | string
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:114
Parameters
- event: "drain"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:115
Parameters
- event: "end"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:116
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:117
Parameters
- event: "finish"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:118
Parameters
- event: "frameError"
- frameType: number
- errorCode: number
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:119
Parameters
- event: "pipe"
- src: stream.Readable
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:120
Parameters
- event: "unpipe"
- src: stream.Readable
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:121
Parameters
- event: "streamClosed"
- code: number
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:122
Parameters
- event: "timeout"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:123
Parameters
- event: "trailers"
- trailers: IncomingHttpHeaders
- flags: number
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:124
Parameters
- event: "wantTrailers"
Returns boolean
Overrides Readable.emit
- Defined in node_modules/@types/node/http2.d.ts:125
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(cb?: function): void
end(chunk: any, cb?: function): void
end(chunk: any, encoding?: BufferEncoding, cb?: function): void

Inherited from Duplex.end
- Defined in node_modules/@types/node/stream.d.ts:267
Parameters
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Inherited from Duplex.end
- Defined in node_modules/@types/node/stream.d.ts:268
Parameters
- chunk: any
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Inherited from Duplex.end
- Defined in node_modules/@types/node/stream.d.ts:269
Parameters
- chunk: any
- Optional encoding: BufferEncoding
- Optional cb: function
  - - (): void
    - Returns void
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.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 EventEmitter.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 EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

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

on

on(event: "aborted", listener: function): this
on(event: "close", listener: function): this
on(event: "data", listener: function): this
on(event: "drain", listener: function): this
on(event: "end", listener: function): this
on(event: "error", listener: function): this
on(event: "finish", listener: function): this
on(event: "frameError", listener: function): this
on(event: "pipe", listener: function): this
on(event: "unpipe", listener: function): this
on(event: "streamClosed", listener: function): this
on(event: "timeout", listener: function): this
on(event: "trailers", listener: function): this
on(event: "wantTrailers", listener: function): this
on(event: string | symbol, listener: function): this

Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:127
Parameters
- event: "aborted"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:128
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:129
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:130
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:131
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:132
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:133
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:134
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:135
Parameters
- event: "pipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:136
Parameters
- event: "unpipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:137
Parameters
- event: "streamClosed"
- listener: function
  - - (code: number): void
    - Parameters
      - code: number
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:138
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:139
Parameters
- event: "trailers"
- listener: function
  - - (trailers: IncomingHttpHeaders, flags: number): void
    - Parameters
      - trailers: IncomingHttpHeaders
      - flags: number
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:140
Parameters
- event: "wantTrailers"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/http2.d.ts:141
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "aborted", listener: function): this
once(event: "close", listener: function): this
once(event: "data", listener: function): this
once(event: "drain", listener: function): this
once(event: "end", listener: function): this
once(event: "error", listener: function): this
once(event: "finish", listener: function): this
once(event: "frameError", listener: function): this
once(event: "pipe", listener: function): this
once(event: "unpipe", listener: function): this
once(event: "streamClosed", listener: function): this
once(event: "timeout", listener: function): this
once(event: "trailers", listener: function): this
once(event: "wantTrailers", listener: function): this
once(event: string | symbol, listener: function): this

Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:143
Parameters
- event: "aborted"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:144
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:145
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:146
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:147
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:148
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:149
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:150
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:151
Parameters
- event: "pipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:152
Parameters
- event: "unpipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:153
Parameters
- event: "streamClosed"
- listener: function
  - - (code: number): void
    - Parameters
      - code: number
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:154
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:155
Parameters
- event: "trailers"
- listener: function
  - - (trailers: IncomingHttpHeaders, flags: number): void
    - Parameters
      - trailers: IncomingHttpHeaders
      - flags: number
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:156
Parameters
- event: "wantTrailers"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/http2.d.ts:157
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pause

pause(): this

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

pipe

pipe<T>(destination: T, options?: object): T

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

prependListener

prependListener(event: "aborted", listener: function): this
prependListener(event: "close", listener: function): this
prependListener(event: "data", listener: function): this
prependListener(event: "drain", listener: function): this
prependListener(event: "end", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "finish", listener: function): this
prependListener(event: "frameError", listener: function): this
prependListener(event: "pipe", listener: function): this
prependListener(event: "unpipe", listener: function): this
prependListener(event: "streamClosed", listener: function): this
prependListener(event: "timeout", listener: function): this
prependListener(event: "trailers", listener: function): this
prependListener(event: "wantTrailers", listener: function): this
prependListener(event: string | symbol, listener: function): this

Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:159
Parameters
- event: "aborted"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:160
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:161
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:162
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:163
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:164
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:165
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:166
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:167
Parameters
- event: "pipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:168
Parameters
- event: "unpipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:169
Parameters
- event: "streamClosed"
- listener: function
  - - (code: number): void
    - Parameters
      - code: number
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:170
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:171
Parameters
- event: "trailers"
- listener: function
  - - (trailers: IncomingHttpHeaders, flags: number): void
    - Parameters
      - trailers: IncomingHttpHeaders
      - flags: number
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:172
Parameters
- event: "wantTrailers"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/http2.d.ts:173
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "aborted", listener: function): this
prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "data", listener: function): this
prependOnceListener(event: "drain", listener: function): this
prependOnceListener(event: "end", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "finish", listener: function): this
prependOnceListener(event: "frameError", listener: function): this
prependOnceListener(event: "pipe", listener: function): this
prependOnceListener(event: "unpipe", listener: function): this
prependOnceListener(event: "streamClosed", listener: function): this
prependOnceListener(event: "timeout", listener: function): this
prependOnceListener(event: "trailers", listener: function): this
prependOnceListener(event: "wantTrailers", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:175
Parameters
- event: "aborted"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:176
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:177
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:178
Parameters
- event: "drain"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:179
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:180
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:181
Parameters
- event: "finish"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:182
Parameters
- event: "frameError"
- listener: function
  - - (frameType: number, errorCode: number): void
    - Parameters
      - frameType: number
      - errorCode: number
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:183
Parameters
- event: "pipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:184
Parameters
- event: "unpipe"
- listener: function
  - - (src: stream.Readable): void
    - Parameters
      - src: stream.Readable
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:185
Parameters
- event: "streamClosed"
- listener: function
  - - (code: number): void
    - Parameters
      - code: number
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:186
Parameters
- event: "timeout"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:187
Parameters
- event: "trailers"
- listener: function
  - - (trailers: IncomingHttpHeaders, flags: number): void
    - Parameters
      - trailers: IncomingHttpHeaders
      - flags: number
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:188
Parameters
- event: "wantTrailers"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/http2.d.ts:189
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

priority

priority(options: StreamPriorityOptions): void

- Defined in node_modules/@types/node/http2.d.ts:91
Parameters
- options: StreamPriorityOptions
Returns void

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 EventEmitter.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): this

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

removeListener

removeListener(event: "close", listener: function): this
removeListener(event: "data", listener: function): this
removeListener(event: "end", listener: function): this
removeListener(event: "error", listener: function): this
removeListener(event: "pause", listener: function): this
removeListener(event: "readable", listener: function): this
removeListener(event: "resume", listener: function): this
removeListener(event: string | symbol, listener: function): this

Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:120
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:121
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:123
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:124
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:125
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:126
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:127
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resume

resume(): this

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

sendTrailers

sendTrailers(headers: OutgoingHttpHeaders): void

- Defined in node_modules/@types/node/http2.d.ts:93
Parameters
- headers: OutgoingHttpHeaders
Returns void

setDefaultEncoding

setDefaultEncoding(encoding: BufferEncoding): this

Inherited from Duplex.setDefaultEncoding
- Defined in node_modules/@types/node/stream.d.ts:266
Parameters
- encoding: BufferEncoding
Returns this

setEncoding

setEncoding(encoding: BufferEncoding): this

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

setMaxListeners

setMaxListeners(n: number): this

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

setTimeout

setTimeout(msecs: number, callback?: function): void

- Defined in node_modules/@types/node/http2.d.ts:92
Parameters
- msecs: number
- Optional callback: function
  - - (): void
    - Returns void
Returns void

uncork

uncork(): void

Inherited from Duplex.uncork
- Defined in node_modules/@types/node/stream.d.ts:271
Returns void

unpipe

unpipe(destination?: WritableStream): this

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

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): this

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

write

write(chunk: any, encoding?: BufferEncoding, cb?: function): boolean
write(chunk: any, cb?: function): boolean

Inherited from Duplex.write
- Defined in node_modules/@types/node/stream.d.ts:264
Parameters
- chunk: any
- Optional encoding: BufferEncoding
- Optional cb: function
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean
Inherited from Duplex.write
- Defined in node_modules/@types/node/stream.d.ts:265
Parameters
- chunk: any
- Optional cb: function
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean

Static from

from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable

Inherited from Readable.from
- Defined in node_modules/@types/node/stream.d.ts:31
A utility method for creating Readable Streams out of iterators.

Parameters
- iterable: Iterable<any> | AsyncIterable<any>
- Optional options: ReadableOptions
Returns Readable

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: DuplexOptions

Returns Http2Stream

Properties

aborted

bufferSize

closed

destroyed

endAfterHeaders

Optional id

pending

readable

readableEncoding

readableEnded

readableFlowing

readableHighWaterMark

readableLength

readableObjectMode

rstCode

sentHeaders

Optional sentInfoHeaders

Optional sentTrailers

session

state

writable

writableCorked

writableEnded

writableFinished

writableHighWaterMark

writableLength

writableObjectMode

Methods

[Symbol.asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

callback: function

Parameters

error: Error | null

Returns void

Returns void

_final

Parameters

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_read

Parameters

size: number

Returns void

_write

Parameters

chunk: any

encoding: BufferEncoding

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<object>

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

addListener

Parameters