BrowserSocket

@codebolt/plugin-sdk

---

Class: BrowserSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/browser.socket.ts:9

Browser WebSocket - Send browser events and receive responses. Events: htmlReceived, clickResponse, scrollResponse, typeResponse, etc.

Extends

• TypedEventEmitter<BrowserSocketEvents>

Constructors

Constructor

new BrowserSocket(connectionManager: SocketConnectionManager, socketName: string): BrowserSocket;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/browser.socket.ts:12

Parameters

Parameter	Type	Default value
connectionManager	SocketConnectionManager	undefined
socketName	string	'browser'

Returns

BrowserSocket

Overrides

TypedEventEmitter.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
listeners	protected	Map<string | symbol, Set<(...args: any[]) => void>>	TypedEventEmitter.listeners	CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:24

Methods

emit()

emit<K>(event: K, ...args: Parameters<BrowserSocketEvents[K]>): boolean;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:54

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
...args	Parameters<BrowserSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

listenerCount()

listenerCount(event: string): number;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:75

Parameters

Parameter	Type
event	string

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

off()

off<K>(event: K, listener: BrowserSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:35

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	BrowserSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: BrowserSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:27

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	BrowserSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: BrowserSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:46

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	BrowserSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

removeAllListeners()

removeAllListeners(event?: string): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:66

Parameters

Parameter	Type
event?	string

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

sendEvent()

sendEvent(event: string, payload?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/browser.socket.ts:49

Send a browser event

Parameters

Parameter	Type
event	string
payload?	unknown

Returns

void