ndt7-js
ndt7-js copied to clipboard
m-lab
ndt7-js
The official NDT7 Javascript client
library. This code works in all modern browsers and is the source for the npm
package @m-lab/ndt7.
Includes an example web client in the examples/ directory. Pull requests
gratefully accepted if you would like to write a more sophisticated web client
that uses the returned measurements to debug network conditions.
In case you need a standalone client binary that you can build and run on multiple operating systems and CPU architectures (including embedded devices) have a look at the official Go client instead.
API Reference
ndt7 : object
Kind: global namespace
- ndt7 :
object- .discoverServerURLS
- .downloadTest ⇒
number - .uploadTest ⇒
number - .test ⇒
number
ndt7.discoverServerURLS
discoverServerURLs contacts a web service (likely the Measurement Lab locate service, but not necessarily) and gets URLs with access tokens in them for the client. It can be short-circuted if config.server exists, which is useful for clients served from the webserver of an NDT server.
Kind: static property of ndt7
Access: public
| Param | Type | Description |
|---|---|---|
| config | Object |
An associative array of configuration options. |
| userCallbacks | Object |
An associative array of user callbacks. It uses the callback functions error, serverDiscovery, and serverChosen. |
ndt7.downloadTest ⇒ number
downloadTest runs just the NDT7 download test.
Kind: static property of ndt7
Returns: number - Zero on success, and non-zero error code on failure.
Access: public
| Param | Type | Description |
|---|---|---|
| config | Object |
An associative array of configuration strings |
| userCallbacks | Object |
|
| urlPromise | Object |
A promise that will resolve to urls. |
ndt7.uploadTest ⇒ number
uploadTest runs just the NDT7 download test.
Kind: static property of ndt7
Returns: number - Zero on success, and non-zero error code on failure.
Access: public
| Param | Type | Description |
|---|---|---|
| config | Object |
An associative array of configuration strings |
| userCallbacks | Object |
|
| urlPromise | Object |
A promise that will resolve to urls. |
ndt7.test ⇒ number
test discovers a server to run against and then runs a download test followed by an upload test.
Kind: static property of ndt7
Returns: number - Zero on success, and non-zero error code on failure.
Access: public
| Param | Type | Description |
|---|---|---|
| config | Object |
An associative array of configuration strings |
| userCallbacks | Object |
m-lab