Package Exports

naruto-run

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (naruto-run) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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)

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

naruto-run