Server | typescript

Hierarchy

EventEmitter
- Server

Index

Constructors

constructor

Properties

Constructors

constructor

new Server(connectionListener?: function): Server
new Server(options?: ServerOpts, connectionListener?: function): Server

Overrides EventEmitter.constructor
- Defined in node_modules/@types/node/net.d.ts:202
Parameters
- Optional connectionListener: function
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns Server
Overrides EventEmitter.constructor
- Defined in node_modules/@types/node/net.d.ts:203
Parameters
- Optional options: ServerOpts
- Optional connectionListener: function
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns Server

Properties

connections

connections: number

listening

listening: boolean

maxConnections

maxConnections: number

Static captureRejectionSymbol

captureRejectionSymbol: keyof symbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static errorMonitor

errorMonitor: keyof symbol

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: string, listener: function): this
addListener(event: "close", listener: function): this
addListener(event: "connection", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "listening", listener: function): this

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:231
events.EventEmitter
1. close
2. connection
3. error
4. listening
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:232
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:233
Parameters
- event: "connection"
- listener: function
  - - (socket: Socket): void
    - Parameters
      - socket: Socket
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:234
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/net.d.ts:235
Parameters
- event: "listening"
- listener: function
  - - (): void
    - Returns void
Returns this

address

address(): AddressInfo | string | null

- Defined in node_modules/@types/node/net.d.ts:216
Returns AddressInfo | string | null

close

close(callback?: function): this

- Defined in node_modules/@types/node/net.d.ts:215
Parameters
- Optional callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns 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

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

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getConnections

getConnections(cb: function): void

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

getMaxListeners

getMaxListeners(): number

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

listen

listen(port?: number, hostname?: string, backlog?: number, listeningListener?: function): this
listen(port?: number, hostname?: string, listeningListener?: function): this
listen(port?: number, backlog?: number, listeningListener?: function): this
listen(port?: number, listeningListener?: function): this
listen(path: string, backlog?: number, listeningListener?: function): this
listen(path: string, listeningListener?: function): this
listen(options: ListenOptions, listeningListener?: function): this
listen(handle: any, backlog?: number, listeningListener?: function): this
listen(handle: any, listeningListener?: function): this

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

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

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

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string, listener: function): this
on(event: "close", listener: function): this
on(event: "connection", listener: function): this
on(event: "error", listener: function): this
on(event: "listening", listener: function): this

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

once

once(event: string, listener: function): this
once(event: "close", listener: function): this
once(event: "connection", listener: function): this
once(event: "error", listener: function): this
once(event: "listening", listener: function): this

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

prependListener

prependListener(event: string, listener: function): this
prependListener(event: "close", listener: function): this
prependListener(event: "connection", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "listening", listener: function): this

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

prependOnceListener

prependOnceListener(event: string, listener: function): this
prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "connection", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "listening", listener: function): this

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

rawListeners

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

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

ref

ref(): this

- Defined in node_modules/@types/node/net.d.ts:218
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

unref

unref(): this

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

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

Static once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional connectionListener: function

Parameters

socket: Socket

Returns void

Returns Server

Parameters

Optional options: ServerOpts

Optional connectionListener: function

Parameters

socket: Socket

Returns void

Returns Server

Properties

connections

listening

maxConnections

Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static errorMonitor

Methods

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "connection"

listener: function

Parameters

socket: Socket

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "listening"

listener: function

Returns void

Returns this

address

Returns AddressInfo | string | null

close

Parameters

Optional callback: function

Parameters

Optional err: Error

Returns void

Returns this

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "close"

Returns boolean

Parameters

event: "connection"