From 93db71863699b4bd2c7c00ae93ac4eff84fb8a6b Mon Sep 17 00:00:00 2001 From: Maximilian Beck Date: Fri, 11 Dec 2015 16:10:45 +0100 Subject: [PATCH] Added syntax highlighting --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b6fcd37..6863461 100644 --- a/README.md +++ b/README.md @@ -14,24 +14,24 @@ This module exports two classes, `Throttle` and `ThrottleGroup`. The `opts` object may also contain options to be passed to the `stream.Transform` constructor. For example, the following code throttles stdin to stdout at 10 bytes per second: - - process.stdin.pipe(new Throttle({rate: 10})).pipe(process.stdout) - +```js +process.stdin.pipe(new Throttle({rate: 10})).pipe(process.stdout) +``` `ThrottleGroup` allows the creation of a group of streams whose aggregate bandwidth is throttled. The constructor accepts the same `opts` argument as for `Throttle`. Call `throttle` on a `ThrottleGroup` object to create a new throttled stream belonging to the group. For example, the following code creates two HTTP connections to `www.google.com:80`, and throttles their aggregate (downstream) bandwidth to 10 KB/s: +```js +var addr = { host: 'www.google.com', port: 80 }; +var tg = new ThrottleGroup({rate: 10240}); - var addr = { host: 'www.google.com', port: 80 }; - var tg = new ThrottleGroup({rate: 10240}); - - var conn1 = net.createConnection(addr), - conn2 = net.createConnection(addr); - - var thr1 = conn1.pipe(tg.throttle()), - thr2 = conn2.pipe(tg.throttle()); +var conn1 = net.createConnection(addr), + conn2 = net.createConnection(addr); - // Reads from thr1 and thr2 are throttled to 10 KB/s in aggregate +var thr1 = conn1.pipe(tg.throttle()), + thr2 = conn2.pipe(tg.throttle()); +// Reads from thr1 and thr2 are throttled to 10 KB/s in aggregate +``` ## Command line usage This package installs a `throttleproxy` binary which implements a command-line utility for throttling connections. Run `throttleproxy -h` for instructions.