Class MockClient

Hierarchy (view full)

Constructors

constructor

Accessors

didPeerCloseConnection incomingPings incomingPongs peerCloseFrame

Methods

abort close connect ping pong popOldestPeerMessage receive send use waitForPeerClosure

Constructors

constructor

  • new MockClient(wsServer, headers?, url?): MockClient

  • Parameters

    • wsServer: Server<typeof WebSocket, typeof IncomingMessage>
    • headers: {
          [key: string]: string;
      } = {}
      • [key: string]: string
    • url: string = '/'

    Returns MockClient

Accessors

didPeerCloseConnection

  • get didPeerCloseConnection(): boolean

  • Returns boolean

incomingPings

incomingPongs

peerCloseFrame

Methods

abort

close

  • close(code?, reason?): void

  • Parameters

    • code: number = 1005
    • Optionalreason: string | Buffer

    Returns void

connect

ping

  • ping(data?): Buffer

  • Send ping to peer and return ping data.

    Parameters

    • Optionaldata: Buffer

    Returns Buffer

pong

popOldestPeerMessage

receive

send

use

  • use(callback): Promise<void>

  • Connect to server, run callback and close the connection.

    Parameters

    • callback: (() => Promise<void>)

      The function to execute whilst connected to server

        • (): Promise<void>

        • Returns Promise<void>

    Returns Promise<void>

waitForPeerClosure

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods