HttpServer | @easy-node/server

Hierarchy

Server
- HttpServer

Index

Constructors

constructor

Properties

Constructors

constructor

new HttpServer(options?: HttpServerOption): HttpServer

Overrides Server.__constructor
- Defined in src/lib/http/HttpServer.ts:11
Parameters
- Default value options: HttpServerOption = HttpServerOption.create()
Returns HttpServer

Properties

connections

connections: number

headersTimeout

headersTimeout: number

Limit the amount of time the parser will wait to receive the complete HTTP headers.

default: 60000 https://nodejs.org/api/http.html#http_server_headerstimeout

keepAliveTimeout

keepAliveTimeout: number

listening

listening: boolean

maxConnections

maxConnections: number

maxHeadersCount

maxHeadersCount: number | null

Limits maximum incoming headers count. If set to 0, no limit will be applied.

default: 2000 https://nodejs.org/api/http.html#http_server_maxheaderscount

router

router: Router = new Router()

timeout

timeout: number

Methods

addListener

addListener(event: string, listener: (...args: any[]) => void): this
addListener(event: "close", listener: () => void): this
addListener(event: "connection", listener: (socket: Socket) => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: "listening", listener: () => void): this

Inherited from HttpServer.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:210
events.EventEmitter
1. close
2. connection
3. error
4. listening
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from HttpServer.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:211
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from HttpServer.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:212
Parameters
- event: "connection"
- listener: (socket: Socket) => void
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns this
Inherited from HttpServer.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:213
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from HttpServer.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:214
Parameters
- event: "listening"
- listener: () => void
  - - (): void
    - Returns void
Returns this

address

address(): AddressInfo | string | null

Inherited from HttpServer.address
- Defined in node_modules/@types/node/net.d.ts:195
Returns AddressInfo | string | null

close

close(callback?: undefined | ((err?: Error) => void)): this

Inherited from HttpServer.close
- Defined in node_modules/@types/node/net.d.ts:194
Parameters
- Optional callback: undefined | ((err?: Error) => void)
Returns this

emit

emit(event: string | symbol, ...args: any[]): boolean
emit(event: "close"): boolean
emit(event: "connection", socket: Socket): boolean
emit(event: "error", err: Error): boolean
emit(event: "listening"): boolean

Inherited from HttpServer.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:216
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from HttpServer.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:217
Parameters
- event: "close"
Returns boolean
Inherited from HttpServer.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:218
Parameters
- event: "connection"
- socket: Socket
Returns boolean
Inherited from HttpServer.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:219
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from HttpServer.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:220
Parameters
- event: "listening"
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from HttpRequest.eventNames
- Defined in node_modules/@types/node/globals.d.ts:569
Returns Array<string | symbol>

getConnections

getConnections(cb: (error: Error | null, count: number) => void): void

Inherited from HttpServer.getConnections
- Defined in node_modules/@types/node/net.d.ts:196
Parameters
- cb: (error: Error | null, count: number) => void
  - - (error: Error | null, count: number): void
    - Parameters
      - error: Error | null
      - count: number
      Returns void
Returns void

getMaxListeners

getMaxListeners(): number

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

Private handleRequest

handleRequest(context: HttpContext): Promise<void>

- Defined in src/lib/http/HttpServer.ts:20
Parameters
- context: HttpContext
Returns Promise<void>

Abstract handlerResponse

handlerResponse(context: HttpContext): void | Promise<void>

- Defined in src/lib/http/HttpServer.ts:49
Parameters
- context: HttpContext
Returns void | Promise<void>

listen

listen(port?: undefined | number, hostname?: undefined | string, backlog?: undefined | number, listeningListener?: undefined | (() => void)): this
listen(port?: undefined | number, hostname?: undefined | string, listeningListener?: undefined | (() => void)): this
listen(port?: undefined | number, backlog?: undefined | number, listeningListener?: undefined | (() => void)): this
listen(port?: undefined | number, listeningListener?: undefined | (() => void)): this
listen(path: string, backlog?: undefined | number, listeningListener?: undefined | (() => void)): this
listen(path: string, listeningListener?: undefined | (() => void)): this
listen(options: ListenOptions, listeningListener?: undefined | (() => void)): this
listen(handle: any, backlog?: undefined | number, listeningListener?: undefined | (() => void)): this
listen(handle: any, listeningListener?: undefined | (() => void)): this

Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:185
Parameters
- Optional port: undefined | number
- Optional hostname: undefined | string
- Optional backlog: undefined | number
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:186
Parameters
- Optional port: undefined | number
- Optional hostname: undefined | string
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:187
Parameters
- Optional port: undefined | number
- Optional backlog: undefined | number
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:188
Parameters
- Optional port: undefined | number
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:189
Parameters
- path: string
- Optional backlog: undefined | number
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:190
Parameters
- path: string
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:191
Parameters
- options: ListenOptions
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:192
Parameters
- handle: any
- Optional backlog: undefined | number
- Optional listeningListener: undefined | (() => void)
Returns this
Inherited from HttpServer.listen
- Defined in node_modules/@types/node/net.d.ts:193
Parameters
- handle: any
- Optional listeningListener: undefined | (() => void)
Returns this

listenerCount

listenerCount(type: string | symbol): number

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

listeners

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

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

off

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

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

on

on(event: string, listener: (...args: any[]) => void): this
on(event: "close", listener: () => void): this
on(event: "connection", listener: (socket: Socket) => void): this
on(event: "error", listener: (err: Error) => void): this
on(event: "listening", listener: () => void): this

Inherited from HttpServer.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:222
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from HttpServer.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:223
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from HttpServer.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:224
Parameters
- event: "connection"
- listener: (socket: Socket) => void
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns this
Inherited from HttpServer.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:225
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from HttpServer.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:226
Parameters
- event: "listening"
- listener: () => void
  - - (): void
    - Returns void
Returns this

onException

onException<E>(context: HttpContext, e: E): void

- Defined in src/lib/http/HttpServer.ts:33
Type parameters
- E: Error
Parameters
- context: HttpContext
- e: E
Returns void

once

once(event: string, listener: (...args: any[]) => void): this
once(event: "close", listener: () => void): this
once(event: "connection", listener: (socket: Socket) => void): this
once(event: "error", listener: (err: Error) => void): this
once(event: "listening", listener: () => void): this

Inherited from HttpServer.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:228
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from HttpServer.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:229
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from HttpServer.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:230
Parameters
- event: "connection"
- listener: (socket: Socket) => void
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns this
Inherited from HttpServer.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:231
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from HttpServer.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:232
Parameters
- event: "listening"
- listener: () => void
  - - (): void
    - Returns void
Returns this

prependListener

prependListener(event: string, listener: (...args: any[]) => void): this
prependListener(event: "close", listener: () => void): this
prependListener(event: "connection", listener: (socket: Socket) => void): this
prependListener(event: "error", listener: (err: Error) => void): this
prependListener(event: "listening", listener: () => void): this

Inherited from HttpServer.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:234
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from HttpServer.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:235
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from HttpServer.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:236
Parameters
- event: "connection"
- listener: (socket: Socket) => void
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns this
Inherited from HttpServer.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:237
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from HttpServer.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:238
Parameters
- event: "listening"
- listener: () => void
  - - (): void
    - Returns void
Returns this

prependOnceListener

prependOnceListener(event: string, listener: (...args: any[]) => void): this
prependOnceListener(event: "close", listener: () => void): this
prependOnceListener(event: "connection", listener: (socket: Socket) => void): this
prependOnceListener(event: "error", listener: (err: Error) => void): this
prependOnceListener(event: "listening", listener: () => void): this

Inherited from HttpServer.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:240
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from HttpServer.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:241
Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Inherited from HttpServer.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:242
Parameters
- event: "connection"
- listener: (socket: Socket) => void
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns this
Inherited from HttpServer.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:243
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from HttpServer.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:244
Parameters
- event: "listening"
- listener: () => void
  - - (): void
    - Returns void
Returns this

rawListeners

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

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

ref

ref(): this

Inherited from HttpServer.ref
- Defined in node_modules/@types/node/net.d.ts:197
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from HttpRequest.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:559
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from HttpServer.removeListener
- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from HttpRequest.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:560
Parameters
- n: number
Returns this

setTimeout

setTimeout(msecs?: undefined | number, callback?: undefined | (() => void)): this
setTimeout(callback: () => void): this

Inherited from HttpServer.setTimeout
- Defined in node_modules/@types/node/http.d.ts:116
Parameters
- Optional msecs: undefined | number
- Optional callback: undefined | (() => void)
Returns this
Inherited from HttpServer.setTimeout
- Defined in node_modules/@types/node/http.d.ts:117
Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns this

unref

unref(): this

Inherited from HttpServer.unref
- Defined in node_modules/@types/node/net.d.ts:198
Returns this

Static createContext

createContext(request: HttpRequest, response: HttpResponse): HttpContext

- Defined in src/lib/http/HttpServer.ts:56
创建 Context

Parameters
- request: HttpRequest
- response: HttpResponse
Returns HttpContext

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value options: HttpServerOption = HttpServerOption.create()

Returns HttpServer

Properties

connections

headersTimeout

keepAliveTimeout

listening

maxConnections

maxHeadersCount

router

timeout

Methods

addListener

Parameters

event: string

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

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: () => void

Returns void

Returns this

Parameters

event: "connection"

listener: (socket: Socket) => void

Parameters

socket: Socket

Returns void

Returns this

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns this

Parameters

event: "listening"

listener: () => void

Returns void

Returns this

address

Returns AddressInfo | string | null

close

Parameters

Optional callback: undefined | ((err?: Error) => void)

Returns this

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "close"

Returns boolean

Parameters

event: "connection"

socket: Socket

Returns boolean

Parameters

event: "error"

err: Error

Returns boolean

Parameters

event: "listening"

Returns boolean

eventNames

Returns Array<string | symbol>

getConnections