_client_registerevent_.md

WebSocketAPI - v1.1.5-1 › Globals › "client/registerEvent"

Module: "client/registerEvent"

Index

Interfaces

• eventObject

Functions

• registerEvent

Functions

registerEvent

▸ registerEvent(name: string, callback: function): eventObject

Defined in lib/client/registerEvent.ts:19

Register a event listener for events sent from the server

Parameters:

▪ name: string

The api name

▪ callback: function

the callback function

▸ (event: Request): void

Parameters:

Name	Type
event	Request

Returns: eventObject