Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Request

Request interface

export
interface

Request

extends

{IncomingMessage}

Hierarchy

  • IncomingMessage
    • Request

Implements

  • ReadableStream

Index

Constructors

constructor

  • new Request(opts?: ReadableOptions): Request
  • Parameters

    • Optional opts: ReadableOptions

    Returns Request

Properties

body

body: any

Body object

type

{*}

memberof

Request

connection

connection: Socket

headers

headers: any

httpVersion

httpVersion: string

httpVersionMajor

httpVersionMajor: number

httpVersionMinor

httpVersionMinor: number

Optional method

method: string

Only valid for request obtained from http.Server.

params

params: any

Parameters object

type

{*}

memberof

Request

parsed

parsed: any

Parsed url

type

{*}

memberof

Request

payload

payload: any

Payload object

type

{*}

memberof

Request

query

query: any

Query object

type

{*}

memberof

Request

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

route

route: any

Route object

type

{*}

memberof

Request

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: any

Optional url

url: string

Only valid for request obtained from http.Server.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Protected _read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function)
  • addListener(event: string, listener: Function)
  • addListener(event: "close", listener: function)
  • addListener(event: "data", listener: function)
  • addListener(event: "end", listener: function)
  • addListener(event: "readable", listener: function)
  • addListener(event: "error", listener: function)
  • Event emitter The defined events on documents including:

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

    Parameters

    • event: string
    • listener: Function
  • Parameters

    • event: string
    • listener: Function
  • Parameters

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

  • Parameters

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

          • chunk: Buffer | string

          Returns void

  • Parameters

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

  • Parameters

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

  • Parameters

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

          • err: Error

          Returns void

destroy

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

    • Optional error: Error

    Returns void

emit

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

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

    Returns boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

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

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

eventNames

  • eventNames(): string | symbol
  • Returns string | symbol

getMaxListeners

  • getMaxListeners(): number
  • Returns number

isPaused

  • isPaused(): boolean
  • Returns boolean

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

on

  • on(event: string, listener: Function)
  • on(event: "close", listener: function)
  • on(event: "data", listener: function)
  • on(event: "end", listener: function)
  • on(event: "readable", listener: function)
  • on(event: "error", listener: function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

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

  • Parameters

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

          • chunk: Buffer | string

          Returns void

  • Parameters

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

  • Parameters

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

  • Parameters

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

          • err: Error

          Returns void

once

  • once(event: string, listener: Function)
  • once(event: "close", listener: function)
  • once(event: "data", listener: function)
  • once(event: "end", listener: function)
  • once(event: "readable", listener: function)
  • once(event: "error", listener: function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

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

  • Parameters

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

          • chunk: Buffer | string

          Returns void

  • Parameters

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

  • Parameters

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

  • Parameters

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

          • err: Error

          Returns void

pause

  • pause(): Readable
  • Returns Readable

pipe

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

    • T: WritableStream

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(event: string, listener: Function)
  • prependListener(event: "close", listener: function)
  • prependListener(event: "data", listener: function)
  • prependListener(event: "end", listener: function)
  • prependListener(event: "readable", listener: function)
  • prependListener(event: "error", listener: function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

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

  • Parameters

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

          • chunk: Buffer | string

          Returns void

  • Parameters

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

  • Parameters

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

  • Parameters

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

          • err: Error

          Returns void

prependOnceListener

  • prependOnceListener(event: string, listener: Function)
  • prependOnceListener(event: "close", listener: function)
  • prependOnceListener(event: "data", listener: function)
  • prependOnceListener(event: "end", listener: function)
  • prependOnceListener(event: "readable", listener: function)
  • prependOnceListener(event: "error", listener: function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

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

  • Parameters

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

          • chunk: Buffer | string

          Returns void

  • Parameters

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

  • Parameters

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

  • Parameters

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

          • err: Error

          Returns void

push

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

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

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

    • Optional size: number

    Returns any

removeAllListeners

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

    • Optional event: string | symbol

removeListener

  • removeListener(event: string, listener: Function)
  • removeListener(event: "close", listener: function)
  • removeListener(event: "data", listener: function)
  • removeListener(event: "end", listener: function)
  • removeListener(event: "readable", listener: function)
  • removeListener(event: "error", listener: function)
  • Parameters

    • event: string
    • listener: Function
  • Parameters

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

  • Parameters

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

          • chunk: Buffer | string

          Returns void

  • Parameters

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

  • Parameters

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

  • Parameters

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

          • err: Error

          Returns void

resume

  • resume(): Readable
  • Returns Readable

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number)
  • Parameters

    • n: number

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    • T: WritableStream

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

  • wrap(oldStream: ReadableStream): ReadableStream
  • Parameters

    • oldStream: ReadableStream

    Returns ReadableStream

Static listenerCount

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

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc