From 703e03aba33f234712206769f57717ba7d92d23d Mon Sep 17 00:00:00 2001 From: LinuxWizard42 Date: Wed, 12 Oct 2022 22:54:37 +0300 Subject: Added export_allowed file to make repository visible in cgit --- node_modules/speedometer/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 node_modules/speedometer/README.md (limited to 'node_modules/speedometer/README.md') 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 -- cgit v1.2.3-86-g962b