Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

aborted

aborted: boolean

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.

pending

pending: boolean

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

rstCode

rstCode: number

sentHeaders

sentHeaders: OutgoingHttpHeaders

Optional sentInfoHeaders

sentInfoHeaders: OutgoingHttpHeaders[]

Optional sentTrailers

sentTrailers: OutgoingHttpHeaders

session

session: Http2Session

state

writable

writable: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__@asyncIterator

_destroy

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

    • error: Error | null
    • callback: function
        • (error: Error | null): void
        • Parameters

          • error: Error | null

          Returns void

    Returns void

_final

  • _final(callback: function): void
  • Parameters

    • callback: function
        • (error?: Error | null): void
        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: function
        • (error?: Error | null): void
        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

Optional _writev

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

    • chunks: Array<object>
    • callback: function
        • (error?: Error | null): void
        • Parameters

          • Optional error: Error | null

          Returns void

    Returns void

addListener

  • addListener(event: string, listener: function): this
  • 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
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "aborted"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "frameError"
    • listener: function
        • (frameType: number, errorCode: number): void
        • Parameters

          • frameType: number
          • errorCode: number

          Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "streamClosed"
    • listener: function
        • (code: number): void
        • Parameters

          • code: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "wantTrailers"
    • listener: function
        • (): void
        • Returns void

    Returns this

close

  • close(code?: undefined | number, callback?: undefined | function): void
  • Parameters

    • Optional code: undefined | number
    • Optional callback: undefined | function

    Returns void

cork

  • cork(): void
  • Returns void

destroy

  • destroy(error?: Error): void
  • Parameters

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • 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
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "aborted"

    Returns boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: Buffer | string

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "finish"

    Returns boolean

  • Parameters

    • event: "frameError"
    • frameType: number
    • errorCode: number

    Returns boolean

  • Parameters

    • event: "pipe"
    • src: stream.Readable

    Returns boolean

  • Parameters

    • event: "unpipe"
    • src: stream.Readable

    Returns boolean

  • Parameters

    • event: "streamClosed"
    • code: number

    Returns boolean

  • Parameters

    • event: "timeout"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "wantTrailers"

    Returns boolean

end

  • end(cb?: undefined | function): void
  • end(chunk: any, cb?: undefined | function): void
  • end(chunk: any, encoding?: undefined | string, cb?: undefined | function): void
  • Parameters

    • Optional cb: undefined | function

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

isPaused

  • isPaused(): boolean
  • Returns boolean

listenerCount

  • listenerCount(type: string | symbol): number

listeners

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

off

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

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): this
  • 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
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "aborted"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "frameError"
    • listener: function
        • (frameType: number, errorCode: number): void
        • Parameters

          • frameType: number
          • errorCode: number

          Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "streamClosed"
    • listener: function
        • (code: number): void
        • Parameters

          • code: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "wantTrailers"
    • listener: function
        • (): void
        • Returns void

    Returns this

once

  • once(event: string, listener: function): this
  • 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
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "aborted"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "frameError"
    • listener: function
        • (frameType: number, errorCode: number): void
        • Parameters

          • frameType: number
          • errorCode: number

          Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "streamClosed"
    • listener: function
        • (code: number): void
        • Parameters

          • code: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "wantTrailers"
    • listener: function
        • (): void
        • Returns void

    Returns this

pause

  • pause(): this
  • Returns this

pipe

  • pipe<T>(destination: T, options?: undefined | object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: undefined | object

    Returns T

prependListener

  • prependListener(event: string, listener: function): this
  • 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
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "aborted"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "frameError"
    • listener: function
        • (frameType: number, errorCode: number): void
        • Parameters

          • frameType: number
          • errorCode: number

          Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "streamClosed"
    • listener: function
        • (code: number): void
        • Parameters

          • code: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "wantTrailers"
    • listener: function
        • (): void
        • Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • 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
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "aborted"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: Buffer | string): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "drain"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "finish"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "frameError"
    • listener: function
        • (frameType: number, errorCode: number): void
        • Parameters

          • frameType: number
          • errorCode: number

          Returns void

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "unpipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "streamClosed"
    • listener: function
        • (code: number): void
        • Parameters

          • code: number

          Returns void

    Returns this

  • Parameters

    • event: "timeout"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "wantTrailers"
    • listener: function
        • (): void
        • Returns void

    Returns this

priority

  • Parameters

    Returns void

push

  • push(chunk: any, encoding?: undefined | string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: undefined | string

    Returns boolean

rawListeners

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

read

  • read(size?: undefined | number): any
  • Parameters

    • Optional size: undefined | number

    Returns any

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

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

resume

  • resume(): this
  • Returns this

sendTrailers

  • Parameters

    Returns this

setDefaultEncoding

  • setDefaultEncoding(encoding: string): this
  • Parameters

    • encoding: string

    Returns this

setEncoding

  • setEncoding(encoding: string): this
  • Parameters

    • encoding: string

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

setTimeout

  • setTimeout(msecs: number, callback?: undefined | function): void
  • Parameters

    • msecs: number
    • Optional callback: undefined | function

    Returns void

uncork

  • uncork(): void
  • Returns void

unpipe

  • Parameters

    Returns this

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

  • Parameters

    Returns this

write

  • write(chunk: any, cb?: undefined | function): boolean
  • write(chunk: any, encoding?: undefined | string, cb?: undefined | function): boolean
  • Parameters

    • chunk: any
    • Optional cb: undefined | function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc