Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncomingMessage

Hierarchy

Index

Methods

Properties

Constructors

Methods

Static once

Static on

Static listenerCount

off

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IncomingMessage

removeAllListeners

setMaxListeners

getMaxListeners

  • getMaxListeners(): number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

eventNames

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

  • Returns (string | symbol)[]

setTimeout

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

destroy

pipe

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

  • Type Parameters

    Parameters

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

    Returns T

Static from

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

setEncoding

pause

resume

isPaused

  • isPaused(): boolean

  • Returns boolean

unpipe

unshift

wrap

push

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

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

_destroy

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

  • Parameters

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

        • Parameters

          • Optional error: Error

          Returns void

    Returns void

addListener

  • Event emitter The defined events on documents including:

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

    Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IncomingMessage

emit

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

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

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

    Returns boolean

on

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IncomingMessage

once

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns <internal>.IncomingMessage

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.IncomingMessage

prependListener

prependOnceListener

removeListener

[asyncIterator]

Properties

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

aborted

aborted: boolean

httpVersion

httpVersion: string

httpVersionMajor

httpVersionMajor: number

httpVersionMinor

httpVersionMinor: number

complete

complete: boolean

connection

connection: <internal>.Socket

headers

headers: <internal>.IncomingHttpHeaders

rawHeaders

rawHeaders: string[]

trailers

trailers: {}

Type declaration

  • [key: string]: string | undefined

rawTrailers

rawTrailers: string[]

Optional method

method?: string

Only valid for request obtained from http.Server.

Optional url

url?: string

Only valid for request obtained from http.Server.

Optional statusCode

statusCode?: number

Only valid for response obtained from http.ClientRequest.

Optional statusMessage

statusMessage?: string

Only valid for response obtained from http.ClientRequest.

socket

socket: <internal>.Socket

readable

readable: boolean

Readonly readableEncoding

readableEncoding: <internal>.BufferEncoding

Readonly readableEnded

readableEnded: boolean

Readonly readableFlowing

readableFlowing: boolean

Readonly readableHighWaterMark

readableHighWaterMark: number

Readonly readableLength

readableLength: number

Readonly readableObjectMode

readableObjectMode: boolean

destroyed

destroyed: boolean

Constructors

constructor

Generated using TypeDoc