Server | Documentation

Hierarchy

<internal>.EventEmitter
- Server

Methods

Static once

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

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

removeListener

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

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

off

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

Inherited from EventEmitter.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 Server

removeAllListeners

removeAllListeners(event?: string | symbol): Server

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/globals.d.ts:735
Parameters
- Optional event: string | symbol
Returns Server

setMaxListeners

setMaxListeners(n: number): Server

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:736
Parameters
- n: number
Returns Server

getMaxListeners

getMaxListeners(): number

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

listeners

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

Inherited from EventEmitter.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 EventEmitter.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 EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:741
Parameters
- type: string | symbol
Returns number

eventNames

eventNames(): (string | symbol)[]

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

listen

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

- Defined in node_modules/@types/node/net.d.ts:207
Parameters
- Optional port: number
- Optional hostname: string
- Optional backlog: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:208
Parameters
- Optional port: number
- Optional hostname: string
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:209
Parameters
- Optional port: number
- Optional backlog: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:210
Parameters
- Optional port: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:211
Parameters
- path: string
- Optional backlog: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:212
Parameters
- path: string
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:213
Parameters
- options: ListenOptions
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:214
Parameters
- handle: any
- Optional backlog: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:215
Parameters
- handle: any
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server

close

close(callback?: ((err?: Error) => void)): Server

- Defined in node_modules/@types/node/net.d.ts:216
Parameters
- Optional callback: ((err?: Error) => void)
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns Server

address

address(): string | <internal>.AddressInfo

- Defined in node_modules/@types/node/net.d.ts:217
Returns string | <internal>.AddressInfo

getConnections

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

- Defined in node_modules/@types/node/net.d.ts:218
Parameters
- cb: ((error: Error, count: number) => void)
  - - (error: Error, count: number): void
    - Parameters
      - error: Error
      - count: number
      Returns void
Returns void

ref

ref(): Server

- Defined in node_modules/@types/node/net.d.ts:219
Returns Server

unref

unref(): Server

- Defined in node_modules/@types/node/net.d.ts:220
Returns Server

addListener

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

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:232
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 Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:233
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:234
Parameters
- event: "connection"
- listener: ((socket: <internal>.Socket) => void)
  - - (socket: <internal>.Socket): void
    - Parameters
      - socket: <internal>.Socket
      Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:235
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:236
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server

emit

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

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:238
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:239
Parameters
- event: "close"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:240
Parameters
- event: "connection"
- socket: <internal>.Socket
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:241
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:242
Parameters
- event: "listening"
Returns boolean

on

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

Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:244
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:245
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:246
Parameters
- event: "connection"
- listener: ((socket: <internal>.Socket) => void)
  - - (socket: <internal>.Socket): void
    - Parameters
      - socket: <internal>.Socket
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:247
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:248
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server

once

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

Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:250
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:251
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:252
Parameters
- event: "connection"
- listener: ((socket: <internal>.Socket) => void)
  - - (socket: <internal>.Socket): void
    - Parameters
      - socket: <internal>.Socket
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:253
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:254
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server

prependListener

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

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:256
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:257
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:258
Parameters
- event: "connection"
- listener: ((socket: <internal>.Socket) => void)
  - - (socket: <internal>.Socket): void
    - Parameters
      - socket: <internal>.Socket
      Returns void
Returns Server
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:259
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:260
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server

prependOnceListener

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

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:262
Parameters
- event: string
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:263
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:264
Parameters
- event: "connection"
- listener: ((socket: <internal>.Socket) => void)
  - - (socket: <internal>.Socket): void
    - Parameters
      - socket: <internal>.Socket
      Returns void
Returns Server
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:265
Parameters
- event: "error"
- listener: ((err: Error) => void)
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:266
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server

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

maxConnections

maxConnections: number

connections

connections: number

listening

listening: boolean

Constructors

constructor

new Server(connectionListener?: ((socket: <internal>.Socket) => void)): Server
new Server(options?: { allowHalfOpen?: boolean; pauseOnConnect?: boolean }, connectionListener?: ((socket: <internal>.Socket) => void)): Server

Overrides EventEmitter.constructor
- Defined in node_modules/@types/node/net.d.ts:204
Parameters
- Optional connectionListener: ((socket: <internal>.Socket) => void)
  - - (socket: <internal>.Socket): void
    - Parameters
      - socket: <internal>.Socket
      Returns void
Returns Server
Overrides EventEmitter.constructor
- Defined in node_modules/@types/node/net.d.ts:205
Parameters
- Optional options: { allowHalfOpen?: boolean; pauseOnConnect?: boolean }
  - Optional allowHalfOpen?: boolean
  - Optional pauseOnConnect?: boolean
- Optional connectionListener: ((socket: <internal>.Socket) => void)
  - - (socket: <internal>.Socket): void
    - Parameters
      - socket: <internal>.Socket
      Returns void
Returns Server

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

removeListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Server

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Server

removeAllListeners

Parameters

Optional event: string | symbol

Returns Server

setMaxListeners

Parameters

n: number

Returns Server

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)[]

listen

Parameters

Optional port: number

Optional hostname: string

Optional backlog: number

Optional listeningListener: (() => void)

Returns void

Returns Server

Parameters

Optional port: number

Optional hostname: string

Optional listeningListener: (() => void)

Returns void

Returns Server

Parameters