ConnectionCheck

Defined in: client-sdk-js/src/connectionHelper/ConnectionCheck.ts:27

Runs a series of connectivity checks against a given server URL. Useful for diagnosing connection problems before entering a room.

Extends

• TypedEmitter<ConnectionCheckEvents>

Constructors

Constructor

new ConnectionCheck(url): ConnectionCheck;

Defined in: client-sdk-js/src/connectionHelper/ConnectionCheck.ts:30

Parameters

url

string

Returns

ConnectionCheck

Overrides

TypedEmitter.constructor

Properties

addListener

addListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:37

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends "statusChanged" ? ConnectionCheckEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.addListener

---

emit

emit: <E>(event, ...args) => boolean;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:17

Type Parameters

E

E extends "statusChanged"

Parameters

event

E

args

…Parameters<ConnectionCheckEvents[E]>

Returns

boolean

Inherited from

TypedEmitter.emit

---

listenerCount

listenerCount: (event) => number;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:57

Parameters

event

string | number

Returns

number

Inherited from

TypedEmitter.listenerCount

---

listeners

listeners: <E>(event) => E extends "statusChanged" ? ConnectionCheckEvents[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:49

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends "statusChanged" ? ConnectionCheckEvents[E][] : ((…args) => void)[]

Inherited from

TypedEmitter.listeners

---

off

off: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:32

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends "statusChanged" ? ConnectionCheckEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.off

---

on

on: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:22

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends "statusChanged" ? ConnectionCheckEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.on

---

once

once: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:27

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends "statusChanged" ? ConnectionCheckEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.once

---

rawListeners

rawListeners: <E>(event) => E extends "statusChanged" ? ConnectionCheckEvents[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:53

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends "statusChanged" ? ConnectionCheckEvents[E][] : ((…args) => void)[]

Inherited from

TypedEmitter.rawListeners

---

removeAllListeners

removeAllListeners: (event?) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:47

Parameters

event?

string | number

Returns

this

Inherited from

TypedEmitter.removeAllListeners

---

removeListener

removeListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:42

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends "statusChanged" ? ConnectionCheckEvents[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.removeListener

---

defaultMaxListeners

static defaultMaxListeners: number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:5

Inherited from

TypedEmitter.defaultMaxListeners

Methods

checkAll()

checkAll(): Promise<CheckInfo[]>;

Defined in: client-sdk-js/src/connectionHelper/ConnectionCheck.ts:75

Returns

Promise<CheckInfo[]>

---

checkPublishAudio()

checkPublishAudio(): Promise<CheckInfo>;

Defined in: client-sdk-js/src/connectionHelper/ConnectionCheck.ts:63

Returns

Promise<CheckInfo>

---

checkPublishVideo()

checkPublishVideo(): Promise<CheckInfo>;

Defined in: client-sdk-js/src/connectionHelper/ConnectionCheck.ts:69

Returns

Promise<CheckInfo>

---

checkSignalConnectivity()

checkSignalConnectivity(): Promise<CheckInfo>;

Defined in: client-sdk-js/src/connectionHelper/ConnectionCheck.ts:35

Returns

Promise<CheckInfo>

---

checkWebRTC()

checkWebRTC(): Promise<CheckInfo>;

Defined in: client-sdk-js/src/connectionHelper/ConnectionCheck.ts:51

Returns

Promise<CheckInfo>

---

eventNames()

eventNames(): (string | number)[];

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:7

Returns

(string | number)[]

Inherited from

TypedEmitter.eventNames

---

getMaxListeners()

getMaxListeners(): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:9

Returns

number

Inherited from

TypedEmitter.getMaxListeners

---

prependListener()

prependListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:14

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

TypedEmitter.prependListener

---

prependOnceListener()

prependOnceListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:15

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

TypedEmitter.prependOnceListener

---

setMaxListeners()

setMaxListeners(n): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:8

Parameters

n

number

Returns

this

Inherited from

TypedEmitter.setMaxListeners

---

listenerCount()

static listenerCount(emitter, type): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:4

Parameters

emitter

EventEmitter

type

string | number

Returns

number

Inherited from

TypedEmitter.listenerCount