Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTPRequest

表示一个 HTTP 请求对象

Hierarchy

  • IncomingMessage
  • object
    • HTTPRequest

Implements

  • ReadableStream

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • socket: Socket

    Returns HTTPRequest

Properties

Optional body

body: Buffer

获取当前请求的二进制内容

complete

complete: boolean

connection

connection: Socket

headers

headers: IncomingHttpHeaders

httpVersion

httpVersion: string

httpVersionMajor

httpVersionMajor: number

httpVersionMinor

httpVersionMinor: number

method

method: string

获取请求的方法

example

"POST"

path

path: string

获取请求的路径名

example

"/index.html"

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: string[]

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

search

search: string | null

获取请求的查询字符串

example

"from=tpack&type=source"

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

Type declaration

  • [key: string]: string | undefined

url

url: string

获取请求的地址

example

"/index.html?from=tpack&type=source"

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

acceptCharsets

  • get acceptCharsets(): object[]

  • 获取客户端支持的所有编码

    Returns object[]

acceptLanguages

  • get acceptLanguages(): object[]

  • 获取客户端的可用语言

    Returns object[]

acceptTypes

  • get acceptTypes(): object[]

  • 获取客户端支持的所有 MIME 类型

    Returns object[]

certificate

  • get certificate(): DetailedPeerCertificate

  • 获取客户端的证书信息，如果请求未使用加密传输协议，则返回 undefined

    Returns DetailedPeerCertificate

contentEncoding

  • get contentEncoding(): string

  • 获取当前请求内容的字符编码

    Returns string

contentLength

  • get contentLength(): number

  • 获取当前请求内容的字节长度

    Returns number

contentType

  • get contentType(): string

  • 获取当前请求内容的 MIME 类型

    Returns string

cookies

  • get cookies(): any

  • 获取请求的 Cookies

    Returns any

data

  • get data(): any

  • 获取用户提交的数据

    Returns any

files

  • 获取当前请求的文件，如果当前请求不包含文件则返回空数组

    Returns HTTPFile[]

forms

  • get forms(): object

  • 获取当前请求的表单数据，如果当前请求不包含表单则返回 undefined

    Returns object

host

  • get host(): string

  • 获取当前请求的主机名和端口

    Returns string

href

  • get href(): string

  • 获取当前请求的绝对地址

    Returns string

ifModifiedSince

  • get ifModifiedSince(): Date

  • 获取客户端的上一次缓存时间

    Returns Date

ip

  • get ip(): string | string[]

  • 获取客户端的 IP 地址，如果用户使用了代理，则尝试获取代理报告的原 IP 地址

    Returns string | string[]

isLocal

  • get isLocal(): boolean

  • 判断当前请求是否来自本机

    Returns boolean

isSecure

  • get isSecure(): boolean

  • 判断当前请求是否使用了加密传输协议（HTTPS）

    Returns boolean

json

  • get json(): any

  • 获取当前请求的 JSON 数据，如果当前请求不包含 JSON 数据则返回 undefined

    Returns any

localAddress

  • get localAddress(): string

  • 获取本地服务端的 IP 地址

    Returns string

localPort

  • get localPort(): number

  • 获取本地服务端的端口

    Returns number

params

  • get params(): object

  • 获取当前请求的所有参数

    Returns object

protocol

  • get protocol(): "https:" | "http:"

  • 获取当前请求的传输协议

    Returns "https:" | "http:"

query

  • get query(): ParsedUrlQuery

  • 获取当前请求的查询参数

    Returns ParsedUrlQuery

referer

  • get referer(): string

  • 获取当前请求的来源地址

    Returns string

remoteAddress

  • get remoteAddress(): string

  • 获取远程客户端的 IP 地址

    Returns string

remotePort

  • get remotePort(): number

  • 获取远程客户端的端口

    Returns number

text

  • get text(): string

  • 获取当前请求的文本内容，如果当前请求不包含内容则返回 undefined

    Returns string

totalBytes

  • get totalBytes(): number

  • 获取当前请求已传输的字节数

    Returns number

userAgent

  • get userAgent(): string

  • 获取客户端的用户代理字符串

    Returns string

Methods

__@asyncIterator

  • __@asyncIterator(): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

_destroy

  • _destroy(error: Error | null, callback: function): void

  • Parameters

    • error: Error | null
    • 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

addListener

  • addListener(event: "close", listener: function): this
  • addListener(event: "data", listener: function): this
  • addListener(event: "end", listener: function): this
  • addListener(event: "readable", listener: function): this
  • addListener(event: "error", listener: function): this
  • addListener(event: string | symbol, listener: function): this

  • Event emitter The defined events on documents including:

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

    Parameters

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

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

destroy

  • destroy(error?: Error): void

  • Parameters

    • Optional error: Error

    Returns void

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

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<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[]

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: "close", listener: function): this
  • on(event: "data", listener: function): this
  • on(event: "end", listener: function): this
  • on(event: "readable", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: string | symbol, listener: function): this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: "close", listener: function): this
  • once(event: "data", listener: function): this
  • once(event: "end", listener: function): this
  • once(event: "readable", listener: function): this
  • once(event: "error", listener: function): this
  • once(event: string | symbol, listener: function): this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

pause

  • pause(): this

  • Returns this

pipe

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

  • Type parameters

    • T: WritableStream

    Parameters

    • destination: T
    • Optional options: object

    Returns T

prependListener

  • prependListener(event: "close", listener: function): this
  • prependListener(event: "data", listener: function): this
  • prependListener(event: "end", listener: function): this
  • prependListener(event: "readable", listener: function): this
  • prependListener(event: "error", listener: function): this
  • prependListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: "close", listener: function): this
  • prependOnceListener(event: "data", listener: function): this
  • prependOnceListener(event: "end", listener: function): this
  • prependOnceListener(event: "readable", listener: function): this
  • prependOnceListener(event: "error", listener: function): this
  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

push

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

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

read

  • read(size?: number): any

  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

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

  • Parameters

    • Optional event: string | symbol

    Returns 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

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

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

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resume

  • resume(): this

  • Returns this

setEncoding

  • setEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setTimeout

  • setTimeout(msecs: number, callback: function): this

  • Parameters

    • msecs: number
    • callback: function
        • (): void

        • Returns void

    Returns this

unpipe

  • unpipe(destination?: WritableStream): this

  • Parameters

    • Optional destination: WritableStream

    Returns this

unshift

  • unshift(chunk: any): void

  • Parameters

    • chunk: any

    Returns void

wrap

  • wrap(oldStream: ReadableStream): this

  • Parameters

    • oldStream: ReadableStream

    Returns this

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc