Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientHttp2Stream

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

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: undefined | number

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

state: StreamState

writable

writable: boolean

writableFinished

writableFinished: 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: "continue", listener: function): this
  • addListener(event: "headers", listener: function): this
  • addListener(event: "push", listener: function): this
  • addListener(event: "response", listener: function): this
  • addListener(event: string | symbol, listener: function): 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

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

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: "continue", listener: function): this
  • on(event: "headers", listener: function): this
  • on(event: "push", listener: function): this
  • on(event: "response", listener: function): this
  • on(event: string | symbol, listener: function): this

once

  • once(event: "continue", listener: function): this
  • once(event: "headers", listener: function): this
  • once(event: "push", listener: function): this
  • once(event: "response", listener: function): this
  • once(event: string | symbol, listener: function): this

pause

  • pause(): this

pipe

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

  • Type parameters

    Parameters

    • destination: T
    • Optional options: undefined | object

    Returns T

prependListener

  • prependListener(event: "continue", listener: function): this
  • prependListener(event: "headers", listener: function): this
  • prependListener(event: "push", listener: function): this
  • prependListener(event: "response", listener: function): this
  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: "continue", listener: function): this
  • prependOnceListener(event: "headers", listener: function): this
  • prependOnceListener(event: "push", listener: function): this
  • prependOnceListener(event: "response", listener: function): this
  • prependOnceListener(event: string | symbol, listener: function): this

priority

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

sendTrailers

setDefaultEncoding

  • setDefaultEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setEncoding

  • setEncoding(encoding: string): 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

unshift

  • Parameters

    Returns void

wrap

write

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

  • Parameters

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

    Returns boolean

  • Parameters

    • chunk: any
    • Optional cb: undefined | function

    Returns boolean

Static from

Static listenerCount

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

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc