@telnyx/rtc-diagnostics
v0.0.0-alpha.1
Published
Telnyx RTC Diagnostics JavaScript Library
Downloads
4
Readme
Telnyx RTC Diagnostics
Telnyx RTC Diagnostics is a troubleshooter tool that can be used to check if your local network can reach out the Telnyx Real Time Comunication Servers.
Features
The following RTC Diagnostics are provided to check if your local network can reach out the public internet and the Telnyx Real Time Comunication Servers.
Prerequisites
- Node.js (v14+)
- NPM (v6+, comes installed with newer Node versions)
Installation
NPM
You can install directly from npm.
yarn add @telnyx/rtc-diagnostics
Usage
import { videoDiagnostics } from '@telnyx/rtc-diagnostics';
const diagnostics = await videoDiagnostics();
console.log(diagnostics);
//Could connect to our services:
/*
{
"internetConnectivity": {
"result": "success"
},
"videoConnectivity": {
"result": "success"
}
}
*/
//Could NOT connect to our services:
/*
{
"internetConnectivity": {
"result": "failure"
},
"videoConnectivity": {
"result": "failure"
}
}
*/