Class Server

Hierarchy

EventEmitter
- Server

Constructors

constructor

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

Properties

connections

connections: number

listening

listening: boolean

maxConnections

maxConnections: number

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`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.

Methods

addListener

addListener(event, listener): Server
events.EventEmitter
1. close
2. connection
3. error
4. listening
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:210
addListener(event, listener): Server
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:211
addListener(event, listener): Server
Parameters
- event: "connection"
- listener: ((socket) => void)
  - - (socket): void
    - Parameters
      socket: Socket
      Returns void
Returns Server
Overrides events.EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:212
addListener(event, listener): Server
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Server
Overrides events.EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:213
addListener(event, listener): Server
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:214

address

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

close

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

emit

emit(event, ...args): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:216
emit(event): boolean
Parameters
- event: "close"
Returns boolean
Overrides events.EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:217
emit(event, socket): boolean
Parameters
- event: "connection"
- socket: Socket
Returns boolean
Overrides events.EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:218
emit(event, err): boolean
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides events.EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:219
emit(event): boolean
Parameters
- event: "listening"
Returns boolean
Overrides events.EventEmitter.emit
- Defined in node_modules/@types/node/net.d.ts:220

eventNames

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

getConnections

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

getMaxListeners

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

listen

listen(port?, hostname?, backlog?, listeningListener?): Server
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:185
listen(port?, hostname?, listeningListener?): Server
Parameters
- Optional port: number
- Optional hostname: string
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:186
listen(port?, backlog?, listeningListener?): Server
Parameters
- Optional port: number
- Optional backlog: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:187
listen(port?, listeningListener?): Server
Parameters
- Optional port: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:188
listen(path, backlog?, listeningListener?): Server
Parameters
- path: string
- Optional backlog: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:189
listen(path, listeningListener?): Server
Parameters
- path: string
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:190
listen(options, listeningListener?): Server
Parameters
- options: ListenOptions
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:191
listen(handle, backlog?, listeningListener?): Server
Parameters
- handle: any
- Optional backlog: number
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:192
listen(handle, listeningListener?): Server
Parameters
- handle: any
- Optional listeningListener: (() => void)
  - - (): void
    - Returns void
Returns Server
- Defined in node_modules/@types/node/net.d.ts:193

listenerCount

listenerCount(type): number
Parameters
- type: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/globals.d.ts:580

listeners

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

off

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

on

on(event, listener): Server
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:222
on(event, listener): Server
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:223
on(event, listener): Server
Parameters
- event: "connection"
- listener: ((socket) => void)
  - - (socket): void
    - Parameters
      socket: Socket
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:224
on(event, listener): Server
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:225
on(event, listener): Server
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/@types/node/net.d.ts:226

once

once(event, listener): Server
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:228
once(event, listener): Server
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:229
once(event, listener): Server
Parameters
- event: "connection"
- listener: ((socket) => void)
  - - (socket): void
    - Parameters
      socket: Socket
      Returns void
Returns Server
Overrides events.EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:230
once(event, listener): Server
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Server
Overrides events.EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:231
once(event, listener): Server
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.once
- Defined in node_modules/@types/node/net.d.ts:232

prependListener

prependListener(event, listener): Server
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:234
prependListener(event, listener): Server
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:235
prependListener(event, listener): Server
Parameters
- event: "connection"
- listener: ((socket) => void)
  - - (socket): void
    - Parameters
      socket: Socket
      Returns void
Returns Server
Overrides events.EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:236
prependListener(event, listener): Server
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Server
Overrides events.EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:237
prependListener(event, listener): Server
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.prependListener
- Defined in node_modules/@types/node/net.d.ts:238

prependOnceListener

prependOnceListener(event, listener): Server
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns Server
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:240
prependOnceListener(event, listener): Server
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:241
prependOnceListener(event, listener): Server
Parameters
- event: "connection"
- listener: ((socket) => void)
  - - (socket): void
    - Parameters
      socket: Socket
      Returns void
Returns Server
Overrides events.EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:242
prependOnceListener(event, listener): Server
Parameters
- event: "error"
- listener: ((err) => void)
  - - (err): void
    - Parameters
      err: Error
      Returns void
Returns Server
Overrides events.EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:243
prependOnceListener(event, listener): Server
Parameters
- event: "listening"
- listener: (() => void)
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/net.d.ts:244

rawListeners

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

ref

ref(): Server
Returns Server
- Defined in node_modules/@types/node/net.d.ts:197

removeAllListeners

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

removeListener

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

setMaxListeners

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

unref

unref(): Server
Returns Server
- Defined in node_modules/@types/node/net.d.ts:198

`Static` listenerCount

listenerCount(emitter, event): number
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Deprecated
since v4.0.0
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter, event): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter, event): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter, event): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22

Class Server

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional connectionListener: ((socket) => void)

Parameters

socket: Socket

Returns void

Returns Server

Parameters

Optional options: { allowHalfOpen?: boolean; pauseOnConnect?: boolean; }

Optional allowHalfOpen?: boolean

Optional pauseOnConnect?: boolean

Optional connectionListener: ((socket) => void)

Parameters

socket: Socket

Returns void

Returns Server

Properties

connections

listening

maxConnections

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string

listener: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns Server

Parameters

event: "close"

listener: (() => void)

Returns void

Returns Server

Parameters

event: "connection"

listener: ((socket) => void)

Parameters

socket: Socket

Returns void

Returns Server

Parameters

event: "error"

listener: ((err) => void)

Parameters

err: Error

Returns void

Returns Server

Parameters

event: "listening"

listener: (() => void)

Returns void

Returns Server

address

Returns null | string | AddressInfo

close

Parameters

Optional callback: ((err?) => void)

Parameters

Optional err: Error

Returns void

Returns Server

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "close"

`Optional` connectionListener: ((socket) => void)

`Optional` options: {
allowHalfOpen?: boolean;
pauseOnConnect?: boolean;
}

`Optional` allowHalfOpen?: boolean

`Optional` pauseOnConnect?: boolean

`Optional` connectionListener: ((socket) => void)

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Rest` ...args: any[]

`Optional` callback: ((err?) => void)

`Optional` err: Error

`Rest` ...args: any[]

`Optional` port: number

`Optional` hostname: string

`Optional` backlog: number

`Optional` listeningListener: (() => void)

`Optional` port: number

`Optional` hostname: string

`Optional` listeningListener: (() => void)

`Optional` port: number

`Optional` backlog: number

`Optional` listeningListener: (() => void)

`Optional` port: number

`Optional` listeningListener: (() => void)

`Optional` backlog: number

`Optional` listeningListener: (() => void)

`Optional` listeningListener: (() => void)

`Optional` listeningListener: (() => void)

`Optional` backlog: number

`Optional` listeningListener: (() => void)