Class MockClient

Hierarchy (view full)

MockPeer
- MockClient

Index

Constructors

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
Overrides MockPeer.constructor
- Defined in lib/MockClient.ts:14

Accessors

didPeerCloseConnection

get didPeerCloseConnection(): boolean
Returns boolean
Inherited from MockPeer.didPeerCloseConnection
- Defined in lib/MockPeer.ts:26

incomingPings

get incomingPings(): readonly PingOrPong[]
Return pings sent by peer.

Returns readonly PingOrPong[]
Inherited from MockPeer.incomingPings
- Defined in lib/MockPeer.ts:106

incomingPongs

get incomingPongs(): readonly PingOrPong[]
Return pongs sent by peer.

Returns readonly PingOrPong[]
Inherited from MockPeer.incomingPongs
- Defined in lib/MockPeer.ts:114

peerCloseFrame

get peerCloseFrame(): null | CloseFrame
Returns null | CloseFrame
Inherited from MockPeer.peerCloseFrame
- Defined in lib/MockPeer.ts:79

Methods

abort

abort(error): void
Parameters
- error: Error
Returns void
Inherited from MockPeer.abort
- Defined in lib/MockPeer.ts:40

close

close(code?, reason?): void
Parameters
- code: number = 1005
- Optional reason: string | Buffer
Returns void
Inherited from MockPeer.close
- Defined in lib/MockPeer.ts:34

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in lib/MockClient.ts:29

ping

ping(data?): Buffer
Send ping to peer and return ping data.
Parameters
- Optional data: Buffer
Returns Buffer
Inherited from MockPeer.ping
- Defined in lib/MockPeer.ts:88

pong

pong(data): void
Send pong to peer.
Parameters
- data: Buffer
Returns void
Inherited from MockPeer.pong
- Defined in lib/MockPeer.ts:99

popOldestPeerMessage

popOldestPeerMessage(): undefined | Data
Returns undefined | Data
Inherited from MockPeer.popOldestPeerMessage
- Defined in lib/MockPeer.ts:71

receive

receive(): Promise<Data>
Returns Promise<Data>
Inherited from MockPeer.receive
- Defined in lib/MockPeer.ts:60

send

send(message): Promise<void>
Parameters
- message: Data
Returns Promise<void>
Inherited from MockPeer.send
- Defined in lib/MockPeer.ts:47

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>
- Defined in lib/MockClient.ts:55

waitForPeerClosure

waitForPeerClosure(): Promise<CloseFrame>
Returns Promise<CloseFrame>
Inherited from MockPeer.waitForPeerClosure
- Defined in lib/MockPeer.ts:75

Generated using TypeDoc