Server | socketit

Hierarchy

EventEmitter
- Server

Index

Constructors

constructor

Properties

Constructors

constructor

new Server(options?: ServerOptions, callback?: () => void): Server

- Defined in node_modules/@types/ws/index.d.ts:231
Parameters
- Optional options: ServerOptions
- Optional callback: () => void
  - - (): void
    - Returns void
Returns Server

Properties

clients

clients: Set<WebSocket>

options

options: ServerOptions

path

path: string

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: unique 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: "connection", cb: (client: WebSocket) => void): this
addListener(event: "error", cb: (err: Error) => void): this
addListener(event: "headers", cb: (headers: string[], request: http.IncomingMessage) => void): this
addListener(event: "close" | "listening", cb: () => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/ws/index.d.ts:260
Parameters
- event: "connection"
- cb: (client: WebSocket) => void
  - - (client: WebSocket): void
    - Parameters
      - client: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:261
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:262
Parameters
- event: "headers"
- cb: (headers: string[], request: http.IncomingMessage) => void
  - - (headers: string[], request: http.IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: http.IncomingMessage
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:263
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:264
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

address

address(): AddressInfo | string

- Defined in node_modules/@types/ws/index.d.ts:235
Returns AddressInfo | string

close

close(cb?: (err?: Error) => void): void

- Defined in node_modules/@types/ws/index.d.ts:236
Parameters
- Optional cb: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

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

getMaxListeners

getMaxListeners(): number

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

handleUpgrade

handleUpgrade(request: http.IncomingMessage, socket: net.Socket, upgradeHead: Buffer, callback: (client: WebSocket, request: http.IncomingMessage) => void): void

- Defined in node_modules/@types/ws/index.d.ts:237
Parameters
- request: http.IncomingMessage
- socket: net.Socket
- upgradeHead: Buffer
- callback: (client: WebSocket, request: http.IncomingMessage) => void
  - - (client: WebSocket, request: http.IncomingMessage): void
    - Parameters
      - client: WebSocket
      - request: http.IncomingMessage
      Returns void
Returns void

listenerCount

listenerCount(event: string | symbol): number

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

listeners

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

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

off

off(event: "connection", cb: (socket: Server, request: WebSocket) => void): this
off(event: "error", cb: (error: Server) => void): this
off(event: "headers", cb: (headers: Server, request: string[]) => void): this
off(event: "close" | "listening", cb: () => void): this
off(event: string | symbol, listener: (...args: Server) => void): this

- Defined in node_modules/@types/ws/index.d.ts:254
Parameters
- event: "connection"
- cb: (socket: Server, request: WebSocket) => void
  - - (socket: Server, request: WebSocket): void
    - Parameters
      - socket: Server
      - request: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:255
Parameters
- event: "error"
- cb: (error: Server) => void
  - - (error: Server): void
    - Parameters
      - error: Server
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:256
Parameters
- event: "headers"
- cb: (headers: Server, request: string[]) => void
  - - (headers: Server, request: string[]): void
    - Parameters
      - headers: Server
      - request: string[]
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:257
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:258
Parameters
- event: string | symbol
- listener: (...args: Server) => void
  - - (...args: Server): void
    - Parameters
      - Rest ...args: Server
      Returns void
Returns this

on

on(event: "connection", cb: (socket: Server, request: WebSocket) => void): this
on(event: "error", cb: (error: Server) => void): this
on(event: "headers", cb: (headers: Server, request: string[]) => void): this
on(event: "close" | "listening", cb: () => void): this
on(event: string | symbol, listener: (...args: Server) => void): this

- Defined in node_modules/@types/ws/index.d.ts:242
Parameters
- event: "connection"
- cb: (socket: Server, request: WebSocket) => void
  - - (socket: Server, request: WebSocket): void
    - Parameters
      - socket: Server
      - request: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:243
Parameters
- event: "error"
- cb: (error: Server) => void
  - - (error: Server): void
    - Parameters
      - error: Server
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:244
Parameters
- event: "headers"
- cb: (headers: Server, request: string[]) => void
  - - (headers: Server, request: string[]): void
    - Parameters
      - headers: Server
      - request: string[]
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:245
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:246
Parameters
- event: string | symbol
- listener: (...args: Server) => void
  - - (...args: Server): void
    - Parameters
      - Rest ...args: Server
      Returns void
Returns this

once

once(event: "connection", cb: (socket: Server, request: WebSocket) => void): this
once(event: "error", cb: (error: Server) => void): this
once(event: "headers", cb: (headers: Server, request: string[]) => void): this
once(event: "close" | "listening", cb: () => void): this
once(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/ws/index.d.ts:248
Parameters
- event: "connection"
- cb: (socket: Server, request: WebSocket) => void
  - - (socket: Server, request: WebSocket): void
    - Parameters
      - socket: Server
      - request: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:249
Parameters
- event: "error"
- cb: (error: Server) => void
  - - (error: Server): void
    - Parameters
      - error: Server
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:250
Parameters
- event: "headers"
- cb: (headers: Server, request: string[]) => void
  - - (headers: Server, request: string[]): void
    - Parameters
      - headers: Server
      - request: string[]
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:251
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:252
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

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

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

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

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

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

removeListener

removeListener(event: "connection", cb: (client: WebSocket) => void): this
removeListener(event: "error", cb: (err: Error) => void): this
removeListener(event: "headers", cb: (headers: string[], request: http.IncomingMessage) => void): this
removeListener(event: "close" | "listening", cb: () => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/ws/index.d.ts:266
Parameters
- event: "connection"
- cb: (client: WebSocket) => void
  - - (client: WebSocket): void
    - Parameters
      - client: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:267
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:268
Parameters
- event: "headers"
- cb: (headers: string[], request: http.IncomingMessage) => void
  - - (headers: string[], request: http.IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: http.IncomingMessage
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:269
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:270
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

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

shouldHandle

shouldHandle(request: http.IncomingMessage): boolean | Promise<boolean>

- Defined in node_modules/@types/ws/index.d.ts:239
Parameters
- request: http.IncomingMessage
Returns boolean | Promise<boolean>

Static listenerCount

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

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: ServerOptions

Optional callback: () => void

Returns void

Returns Server

Properties

clients

options

path

Static defaultMaxListeners

Readonly Static errorMonitor

Methods

addListener

Parameters

event: "connection"

cb: (client: WebSocket) => void

Parameters

client: WebSocket

Returns void

Returns this

Parameters

event: "error"

cb: (err: Error) => void

Parameters

err: Error

Returns void

Returns this

Parameters

event: "headers"

cb: (headers: string[], request: http.IncomingMessage) => void

Parameters

headers: string[]

request: http.IncomingMessage

Returns void

Returns this

Parameters

event: "close" | "listening"

cb: () => void

Returns void

Returns this

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns this

address

Returns AddressInfo | string

close

Parameters

Optional cb: (err?: Error) => void

Parameters

Optional err: Error

Returns void

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

handleUpgrade

Parameters

request: http.IncomingMessage

socket: net.Socket

upgradeHead: Buffer

callback: (client: WebSocket, request: http.IncomingMessage) => void

Parameters

client: WebSocket