_ws_wsclient_.wsclient.md

WebSocketAPI - v1.1.5-1 › Globals › "ws/wsClient" › wsClient

Class: wsClient

Hierarchy

• wsClient

Index

Constructors

• constructor

Properties

• WebSocket
• _index
• client
• events
• request

Methods

• api
• fetch
• newIndex

Constructors

constructor

+ new wsClient(ws: WebSocket, request: ExpressRequest, client?: any): wsClient

Defined in lib/ws/wsClient.ts:25

Parameters:

Name	Type
ws	WebSocket
request	ExpressRequest
client?	any

Returns: wsClient

Properties

WebSocket

• WebSocket: WebSocket

Defined in lib/ws/wsClient.ts:21

---

_index

• _index: number

Defined in lib/ws/wsClient.ts:24

---

client

• client: any

Defined in lib/ws/wsClient.ts:23

---

events

• events: FetchEvent[]

Defined in lib/ws/wsClient.ts:25

---

request

• request: ExpressRequest

Defined in lib/ws/wsClient.ts:22

Methods

api

▸ api(api: string): object

Defined in lib/ws/wsClient.ts:62

Send a api request to the client

Parameters:

Name	Type	Description
api	string	The event name to send to client

Returns: object

• delete(body: any, options?: requestOptions): Promise‹unknown›

• get(body: any, options?: requestOptions): Promise‹unknown›

• post(body: any, options?: requestOptions): Promise‹unknown›

• put(body: any, options?: requestOptions): Promise‹unknown›

---

fetch

▸ fetch(api: string, body?: any, options?: requestOptions): Promise‹unknown›

Defined in lib/ws/wsClient.ts:102

Send a reverse fetch to the client.

This allows you to make a request to the connected client from the server or send updated data to the client when it comes available

Parameters:

Name	Type	Description
api	string	The api event name to send
body?	any	the payload to send with the request
options?	requestOptions	the options for the request

Returns: Promise‹unknown›

---

newIndex

▸ newIndex(): number

Defined in lib/ws/wsClient.ts:155

Returns: number