Class: SocketManager

Defined in: socket.ts:7

Constructors

Constructor

new SocketManager(createSocket?): SocketManager;

Defined in: socket.ts:18

Parameters

Parameter	Type	Default value
createSocket?	{ (opts?): Socket; (uri?, opts?): Socket; }	io

Returns

SocketManager

Accessors

isConnected

Get Signature

get isConnected(): boolean;

Defined in: socket.ts:121

Returns

boolean

Methods

disconnect()

disconnect(): void;

Defined in: socket.ts:113

Returns

void

---

emit()

emit(event, data?): void;

Defined in: socket.ts:99

Parameters

Parameter	Type
event	string
data?	unknown

Returns

void

---

emitWithAck()

emitWithAck<T>(
   event, 
   data, 
   timeoutMs?
): Promise<T>;

Defined in: socket.ts:108

Emit, and settle with the server's answer. Sent at once when connected, or when the socket reconnects; rejects with no socket, or no answer within timeoutMs.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type	Default value
event	string	undefined
data	unknown	undefined
timeoutMs?	number	10_000

Returns

Promise<T>

---

ensureConnected()

ensureConnected(url, token): void;

Defined in: socket.ts:26

Parameters

Parameter	Type
url	string
token	string

Returns

void

---

off()

off(event, handler): void;

Defined in: socket.ts:77

Parameters

Parameter	Type
event	string
handler	Handler

Returns

void

---

offAny()

offAny(handler): void;

Defined in: socket.ts:94

Parameters

Parameter	Type
handler	(event, ...args) => void

Returns

void

---

on()

on(event, handler): () => void;

Defined in: socket.ts:62

Parameters

Parameter	Type
event	string
handler	Handler

Returns

() => void

---

onAny()

onAny(handler): () => void;

Defined in: socket.ts:86

Parameters

Parameter	Type
handler	(event, ...args) => void

Returns

() => void

---

setMobilePlatform()

setMobilePlatform(platform): void;

Defined in: socket.ts:21

Native apps identify their OS before connecting; browsers are detected automatically.

Parameters

Parameter	Type
platform	IMobilePlatform | null

Returns

void