Server | @noveo/dual-rpc-ws

Hierarchy

Server
- Server

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

clients

clients: Set<WebSocket>

options

options: ServerOptions

path

path: string

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: IncomingMessage) => void): this
addListener(event: "close" | "listening", cb: () => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:241
Parameters
- event: "connection"
- cb: (client: WebSocket) => void
  - - (client: WebSocket): void
    - Parameters
      - client: WebSocket
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:242
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:243
Parameters
- event: "headers"
- cb: (headers: string[], request: IncomingMessage) => void
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:244
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:245
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:228
Returns AddressInfo | string

close

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

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

emit

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

Inherited from ClientSocket.emit
- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

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

getMaxListeners

getMaxListeners(): number

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

handleUpgrade

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

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

listenerCount

listenerCount(type: string | symbol): number

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

listeners

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

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

off

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

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

on

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

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:235
Parameters
- event: "connection"
- cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void
  - - (this: Server, socket: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: Server
      - socket: WebSocket
      - request: IncomingMessage
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:236
Parameters
- event: "error"
- cb: (this: Server, error: Error) => void
  - - (this: Server, error: Error): void
    - Parameters
      - this: Server
      - error: Error
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:237
Parameters
- event: "headers"
- cb: (this: Server, headers: string[], request: IncomingMessage) => void
  - - (this: Server, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:238
Parameters
- event: "close" | "listening"
- cb: (this: Server) => void
  - - (this: Server): void
    - Parameters
      - this: Server
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:239
Parameters
- event: string | symbol
- listener: (this: Server, ...args: any[]) => void
  - - (this: Server, ...args: any[]): void
    - Parameters
      - this: Server
      - Rest ...args: any[]
      Returns void
Returns this

once

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

Inherited from ClientSocket.once
- Defined in node_modules/@types/node/globals.d.ts:549
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

Inherited from ClientSocket.prependListener
- Defined in node_modules/@types/node/globals.d.ts:560
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

Inherited from ClientSocket.prependOnceListener
- Defined in node_modules/@types/node/globals.d.ts:561
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[]

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

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

removeListener

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

Inherited from Server.removeListener
- Defined in node_modules/@types/node/globals.d.ts:550
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 ClientSocket.setMaxListeners
- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns this

shouldHandle

shouldHandle(request: IncomingMessage): boolean

- Defined in node_modules/@types/ws/index.d.ts:232
Parameters
- request: IncomingMessage
Returns boolean

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: ServerOptions

Optional callback: undefined | (() => void)

Returns Server

Properties

clients

options

path

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: IncomingMessage) => void

Parameters

headers: string[]

request: 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: undefined | ((err?: Error) => void)

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

handleUpgrade

Parameters

request: IncomingMessage

socket: Socket

upgradeHead: Buffer

callback: (client: WebSocket) => void

Parameters

client: WebSocket

Returns void

Returns void

listenerCount

Parameters

type: string | symbol

Returns number