naruto-run
v0.1.11
Published
A simple React component for running Vonage's Network Precall Test.
Downloads
5
Maintainers
Readme
Naruto Run
A simple React component for running Vonage's Network Precall Test. The pre-call test is comprehensive and tests the following:
- Connectivity to all Vonage Video API servers.
- Bitrate and packet loss statistics
- Hardware and software setup on the client (camera, microphone, browser)
Technical Documentation
Installing
You can install naruto-run into your project by using both npm or yarn following the below commands.
#NPM
$ npm install naruto-run
#YARN
$ yarn add naruto-run
Usage
import { NetworkTest } from "naruto-run"
<NetworkTest
apiKey='ABRACADABRA'
apiSecret='ABRACADABRA'
onSuccess={(results)=>console.log("Network Test Results : ",results)}
onFailure={(error)=>console.log("Something went wrong",error)}
/>
<NetworkTest>
Props:
{
//API Secret
apiKey: string,
//API Secret
apiSecret:string,
//Called if the network test runs completely
onSuccess: (result) => void,
//Called if there is any error while running the test
onFailure: (error) => void
}
Contributing
- Fork the project
- Run the project in development mode:
$ yarn start
- Make changes.
- Update README with appropriate docs.
- Commit and PR
Release checklist
- Update CHANGELOG
License
MIT