diff options
author | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
---|---|---|
committer | LinuxWizard42 <computerwizard@linuxmail.org> | 2022-10-12 22:54:37 +0300 |
commit | 703e03aba33f234712206769f57717ba7d92d23d (patch) | |
tree | 0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/speedometer/README.md | |
parent | ab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff) | |
download | FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst |
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/speedometer/README.md')
-rw-r--r-- | node_modules/speedometer/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/node_modules/speedometer/README.md b/node_modules/speedometer/README.md new file mode 100644 index 0000000..f4e5711 --- /dev/null +++ b/node_modules/speedometer/README.md @@ -0,0 +1,38 @@ +# speedometer + +Speed measurement in Javascript + +``` +npm install speedometer +``` + +## Usage + +``` js +var speedometer = require('speedometer') +var fs = require('fs') + +// Let's measure how fast we can read from /dev/urandom +var speed = speedometer() +var stream = fs.createReadStream('/dev/urandom') + +stream.on('data', function(data) { + // Simply call speed with the amount of bytes transferred + var bytesPerSecond = speed(data.length) + + console.log(bytesPerSecond+' bytes/second') +}) +``` + +You can always get the current speed by calling `speed()`. + +Per default `speedometer` uses a 5 second buffer. +To change this simply pass another value to the constructor + +``` js +var speed = speedometer(20) // uses a 20s buffer instead +``` + +## License + +MIT |