IncomingMessage | Documentation

Hierarchy

<internal>.Readable
- IncomingMessage

Methods

Static once

once(emitter: <internal>.NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: <internal>.DOMEventTarget, event: string): Promise<any[]>

Inherited from Readable.once
- Defined in node_modules/@types/node/events.d.ts:13
Parameters
- emitter: <internal>.NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from Readable.once
- Defined in node_modules/@types/node/events.d.ts:14
Parameters
- emitter: <internal>.DOMEventTarget
- event: string
Returns Promise<any[]>

Static on

on(emitter: <internal>.EventEmitter, event: string): <internal>.AsyncIterableIterator<any>

Inherited from Readable.on
- Defined in node_modules/@types/node/events.d.ts:15
Parameters
- emitter: <internal>.EventEmitter
- event: string
Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from Readable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

off

off(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.IncomingMessage

Inherited from Readable.off
- Defined in node_modules/@types/node/globals.d.ts:734
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.IncomingMessage

removeAllListeners

removeAllListeners(event?: string | symbol): <internal>.IncomingMessage

Inherited from Readable.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:735
Parameters
- Optional event: string | symbol
Returns <internal>.IncomingMessage

setMaxListeners

setMaxListeners(n: number): <internal>.IncomingMessage

Inherited from Readable.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:736
Parameters
- n: number
Returns <internal>.IncomingMessage

getMaxListeners

getMaxListeners(): number

Inherited from Readable.getMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:737
Returns number

listeners

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

Inherited from Readable.listeners
- Defined in node_modules/@types/node/globals.d.ts:738
Parameters
- event: string | symbol
Returns Function[]

rawListeners

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

Inherited from Readable.rawListeners
- Defined in node_modules/@types/node/globals.d.ts:739
Parameters
- event: string | symbol
Returns Function[]

listenerCount

listenerCount(type: string | symbol): number

Inherited from Readable.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:741
Parameters
- type: string | symbol
Returns number

eventNames

eventNames(): (string | symbol)[]

Inherited from Readable.eventNames
- Defined in node_modules/@types/node/globals.d.ts:745
Returns (string | symbol)[]

setTimeout

setTimeout(msecs: number, callback?: (() => void)): <internal>.IncomingMessage

- Defined in node_modules/@types/node/http.d.ts:357
Parameters
- msecs: number
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage

destroy

destroy(error?: Error): <internal>.IncomingMessage

Overrides Readable.destroy
- Defined in node_modules/@types/node/http.d.ts:375
Parameters
- Optional error: Error
Returns <internal>.IncomingMessage

pipe

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

Inherited from Readable.pipe
- Defined in node_modules/@types/node/stream.d.ts:5
Type Parameters
- T extends <internal>.WritableStream<T>
Parameters
- destination: T
- Optional options: { end?: boolean }
  - Optional end?: boolean
Returns T

Static from

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

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

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

_read

_read(size: number): void

Inherited from Readable._read
- Defined in node_modules/@types/node/stream.d.ts:35
Parameters
- size: number
Returns void

read

read(size?: number): any

Inherited from Readable.read
- Defined in node_modules/@types/node/stream.d.ts:36
Parameters
- Optional size: number
Returns any

setEncoding

setEncoding(encoding: string): <internal>.IncomingMessage

Inherited from Readable.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:37
Parameters
- encoding: string
Returns <internal>.IncomingMessage

pause

pause(): <internal>.IncomingMessage

Inherited from Readable.pause
- Defined in node_modules/@types/node/stream.d.ts:38
Returns <internal>.IncomingMessage

resume

resume(): <internal>.IncomingMessage

Inherited from Readable.resume
- Defined in node_modules/@types/node/stream.d.ts:39
Returns <internal>.IncomingMessage

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in node_modules/@types/node/stream.d.ts:40
Returns boolean

unpipe

unpipe(destination?: <internal>.WritableStream): <internal>.IncomingMessage

Inherited from Readable.unpipe
- Defined in node_modules/@types/node/stream.d.ts:41
Parameters
- Optional destination: <internal>.WritableStream
Returns <internal>.IncomingMessage

unshift

unshift(chunk: any, encoding?: <internal>.BufferEncoding): void

Inherited from Readable.unshift
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- chunk: any
- Optional encoding: <internal>.BufferEncoding
Returns void

wrap

wrap(oldStream: <internal>.ReadableStream): <internal>.IncomingMessage

Inherited from Readable.wrap
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- oldStream: <internal>.ReadableStream
Returns <internal>.IncomingMessage

push

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

Inherited from Readable.push
- Defined in node_modules/@types/node/stream.d.ts:44
Parameters
- chunk: any
- Optional encoding: string
Returns boolean

_destroy

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

Inherited from Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:45
Parameters
- error: Error
- callback: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

addListener

addListener(event: "close", listener: (() => void)): <internal>.IncomingMessage
addListener(event: "data", listener: ((chunk: any) => void)): <internal>.IncomingMessage
addListener(event: "end", listener: (() => void)): <internal>.IncomingMessage
addListener(event: "readable", listener: (() => void)): <internal>.IncomingMessage
addListener(event: "error", listener: ((err: Error) => void)): <internal>.IncomingMessage
addListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.IncomingMessage

Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:57
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
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:58
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:59
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:60
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:61
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.addListener
- Defined in node_modules/@types/node/stream.d.ts:62
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

Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:64
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:65
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:66
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:67
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:68
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit
- Defined in node_modules/@types/node/stream.d.ts:69
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

on

on(event: "close", listener: (() => void)): <internal>.IncomingMessage
on(event: "data", listener: ((chunk: any) => void)): <internal>.IncomingMessage
on(event: "end", listener: (() => void)): <internal>.IncomingMessage
on(event: "readable", listener: (() => void)): <internal>.IncomingMessage
on(event: "error", listener: ((err: Error) => void)): <internal>.IncomingMessage
on(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.IncomingMessage

Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:71
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:72
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:73
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:74
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.on
- Defined in node_modules/@types/node/stream.d.ts:76
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.IncomingMessage

once

once(event: "close", listener: (() => void)): <internal>.IncomingMessage
once(event: "data", listener: ((chunk: any) => void)): <internal>.IncomingMessage
once(event: "end", listener: (() => void)): <internal>.IncomingMessage
once(event: "readable", listener: (() => void)): <internal>.IncomingMessage
once(event: "error", listener: ((err: Error) => void)): <internal>.IncomingMessage
once(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.IncomingMessage

Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:78
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:79
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:80
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:81
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:82
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.once
- Defined in node_modules/@types/node/stream.d.ts:83
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.IncomingMessage

prependListener

prependListener(event: "close", listener: (() => void)): <internal>.IncomingMessage
prependListener(event: "data", listener: ((chunk: any) => void)): <internal>.IncomingMessage
prependListener(event: "end", listener: (() => void)): <internal>.IncomingMessage
prependListener(event: "readable", listener: (() => void)): <internal>.IncomingMessage
prependListener(event: "error", listener: ((err: Error) => void)): <internal>.IncomingMessage
prependListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.IncomingMessage

Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:85
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:86
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:87
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:88
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:89
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependListener
- Defined in node_modules/@types/node/stream.d.ts:90
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.IncomingMessage

prependOnceListener

prependOnceListener(event: "close", listener: (() => void)): <internal>.IncomingMessage
prependOnceListener(event: "data", listener: ((chunk: any) => void)): <internal>.IncomingMessage
prependOnceListener(event: "end", listener: (() => void)): <internal>.IncomingMessage
prependOnceListener(event: "readable", listener: (() => void)): <internal>.IncomingMessage
prependOnceListener(event: "error", listener: ((err: Error) => void)): <internal>.IncomingMessage
prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.IncomingMessage

Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:92
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:93
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:94
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:95
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:96
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.prependOnceListener
- Defined in node_modules/@types/node/stream.d.ts:97
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.IncomingMessage

removeListener

removeListener(event: "close", listener: (() => void)): <internal>.IncomingMessage
removeListener(event: "data", listener: ((chunk: any) => void)): <internal>.IncomingMessage
removeListener(event: "end", listener: (() => void)): <internal>.IncomingMessage
removeListener(event: "readable", listener: (() => void)): <internal>.IncomingMessage
removeListener(event: "error", listener: ((err: Error) => void)): <internal>.IncomingMessage
removeListener(event: string | symbol, listener: ((...args: any[]) => void)): <internal>.IncomingMessage

Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:99
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:100
Parameters
- event: "data"
- listener: ((chunk: any) => void)
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:101
Parameters
- event: "end"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:102
Parameters
- event: "readable"
- listener: (() => void)
  - - (): void
    - Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:103
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns <internal>.IncomingMessage
Inherited from Readable.removeListener
- Defined in node_modules/@types/node/stream.d.ts:104
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns <internal>.IncomingMessage

[asyncIterator]

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

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

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

new IncomingMessage(socket: <internal>.Socket): <internal>.IncomingMessage

Overrides Readable.constructor
- Defined in node_modules/@types/node/http.d.ts:345
Parameters
- socket: <internal>.Socket
Returns <internal>.IncomingMessage

Hierarchy

Index

Methods

Properties

Constructors

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

off

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns <internal>.IncomingMessage

removeAllListeners

Parameters

Optional event: string | symbol

Returns <internal>.IncomingMessage

setMaxListeners

Parameters

n: number

Returns <internal>.IncomingMessage

getMaxListeners

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

rawListeners

Parameters

event: string | symbol

Returns Function[]

listenerCount

Parameters

type: string | symbol

Returns number

eventNames

Returns (string | symbol)[]

setTimeout

Parameters

msecs: number

Optional callback: (() => void)

Returns void

Returns <internal>.IncomingMessage

destroy

Parameters

Optional error: Error

Returns <internal>.IncomingMessage

pipe

Type Parameters

T extends <internal>.WritableStream<T>

Parameters

destination: T

Optional options: { end?: boolean }

Optional end?: boolean

Returns T

Static from

Parameters

iterable: <internal>.Iterable<any> | <internal>.AsyncIterable<any>

Optional options: <internal>.ReadableOptions

Returns <internal>.Readable