_events_event_.events.md

WebSocketAPI - v1.1.5-1 › Globals › "events/event" › Events

Class: Events

Hierarchy

• Events

Index

Constructors

• constructor

Properties

• events

Methods

• on
• remove
• triggerEvent

Constructors

constructor

+ new Events(): Events

Defined in lib/events/event.ts:6

Returns: Events

Properties

events

• events: object

Defined in lib/events/event.ts:6

Type declaration:

• [ key: string]: Function[]

Methods

on

▸ on(name: string, callback: Function): void

Defined in lib/events/event.ts:58

Add a Event listener to the event name

Parameters:

Name	Type	Description
name	string	The event name
callback	Function	The callback function.

Returns: void

---

remove

▸ remove(name: string, callback: Function): void

Defined in lib/events/event.ts:73

Remove the event from the list

Parameters:

Name	Type	Description
name	string	The event name
callback	Function	the callback to remove

Returns: void

---

triggerEvent

▸ triggerEvent(event: Request): void

Defined in lib/events/event.ts:21

Trigger a event

Parameters:

Name	Type	Description
event	Request

Returns: void