Class IncomingMessage

Hierarchy (view full)

Constructors

constructor

Properties

connection headers httpVersion httpVersionMajor httpVersionMinor method? rawHeaders rawTrailers readable readableHighWaterMark socket statusCode? statusMessage? trailers url? defaultMaxListeners

Methods

_destroy _read addListener destroy emit eventNames getMaxListeners isPaused listenerCount listeners on once pause pipe prependListener prependOnceListener push read removeAllListeners removeListener resume setEncoding setMaxListeners setTimeout unpipe unshift wrap listenerCount

Constructors

constructor

Properties

connection

connection: Socket

headers

headers: IncomingHttpHeaders

httpVersion

httpVersion: string

httpVersionMajor

httpVersionMajor: number

httpVersionMinor

httpVersionMinor: number

Optional method

method?: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: string[]

readable

readable: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

socket

socket: Socket

Optional statusCode

statusCode?: number

Only valid for response obtained from http.ClientRequest.

Optional statusMessage

statusMessage?: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: {
    [key: string]: string | undefined;
}

Type declaration

  • [key: string]: string | undefined

Optional url

url?: string

Only valid for request obtained from http.Server.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_destroy

  • _destroy(error, callback): void

  • Parameters

    • error: null | Error
    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: Error

          Returns void

    Returns void

_read

  • _read(size): void

  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event, listener): this

  • Event emitter The defined events on documents including:

    1. close
    2. data
    3. end
    4. readable
    5. error

    Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void

        • Parameters

          Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns this

destroy

  • destroy(error?): void

  • Parameters

    • Optional error: Error

    Returns void

emit

  • emit(event, ...args): boolean

  • Parameters

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

    Returns boolean

  • emit(event): boolean

  • Parameters

    • event: "close"

    Returns boolean

  • emit(event, chunk): boolean

  • Parameters

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

    Returns boolean

  • emit(event): boolean

  • Parameters

    • event: "end"

    Returns boolean

  • emit(event): boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • emit(event, err): boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

isPaused

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void

        • Parameters

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns this

once

  • once(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void

        • Parameters

          Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • once(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns this

pause

pipe

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

  • Type Parameters

    Parameters

    • destination: T
    • Optional options: {
          end?: boolean;
      }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void

        • Parameters

          Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependListener(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void

        • Parameters

          Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • prependOnceListener(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns this

push

  • push(chunk, encoding?): boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event, listener): this

  • Parameters

    • event: string
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • removeListener(event, listener): this

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • removeListener(event, listener): this

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void

        • Parameters

          Returns void

    Returns this

  • removeListener(event, listener): this

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • removeListener(event, listener): this

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • removeListener(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns this

resume

setEncoding

  • setEncoding(encoding): this

  • Parameters

    • encoding: string

    Returns this

setMaxListeners

setTimeout

  • setTimeout(msecs, callback): this

  • Parameters

    • msecs: number
    • callback: (() => void)
        • (): void

        • Returns void

    Returns this

unpipe

unshift

  • unshift(chunk): void

  • Parameters

    • chunk: any

    Returns void

wrap

Static listenerCount

Settings

Member Visibility

Theme

On This Page