@vpalmisano/throttler 0.0.7

package/README.md

@@ -0,0 +1,40 @@
+![logo](media/logo.svg "Throttler")
+# Throttler
+[GitHub page](https://github.com/vpalmisano/throttler) | [Documentation](https://vpalmisano.github.io/throttler)
+
+A Linux tool that allows to apply network constraints to a single or a group of processes.
+
+## Install
+```bash
+echo '@vpalmisano:registry=https://npm.pkg.github.com' >> ~/.npmrc
+
+npm install -g @vpalmisano/throttler
+```
+
+System configuration:
+```bash
+# Allow to run the required comamnds without password:
+echo "$(whoami) ALL=(ALL) NOPASSWD: $(which iptables),$(which addgroup),$(which adduser),$(which tc),$(which modprobe),$(which ip)" | sudo tee /etc/sudoers.d/throttler
+
+# Install wireshark and allow regular user to capture packets:
+sudo apt install -y wireshark
+sudo dpkg-reconfigure wireshark-common
+sudo usermod -a -G wireshark $(whoami)
+# Logout and login again
+```
+
+## Examples
+Throttle all the traffic of a single process (e.g. firefox):
+```bash
+throttler \
+    --throttle-config '[{sessions:"0",up:[{delay:20,rate:5000}],down:[{delay:20,rate:5000}]}]' \
+    --command-config '[{session:0,command:"firefox https://www.speedtest.net"}]'
+# press q to stop the throttler
+```
+
+Throttle the udp traffic of a single process (e.g. firefox) and capture the packets:
+```bash
+throttler \
+    --throttle-config '[{sessions:"0",protocol:"udp",capture:"capture.pcap",up:[{delay:50,loss:1,rate:2000}],down:[{delay:20,loss:1,rate:2000}]}]' \
+    --command-config '[{session:0,command:"firefox https://meet.jit.si/"}]'
+```

package/build/src/app.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/app.js

@@ -0,0 +1,134 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const change_case_1 = require("change-case");
+const child_process_1 = require("child_process");
+const fs_1 = __importDefault(require("fs"));
+const json5_1 = __importDefault(require("json5"));
+const word_wrap_1 = __importDefault(require("word-wrap"));
+const config_1 = require("./config");
+const throttle_1 = require("./throttle");
+const utils_1 = require("./utils");
+const log = (0, utils_1.logger)('throttler');
+function showHelpOrVersion() {
+    if (process.argv.findIndex(a => a.localeCompare('--help') === 0) !== -1) {
+        const docs = (0, config_1.getConfigDocs)();
+        let out = `Params:\n  --version\n        It shows the package version.\n`;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        Object.entries(docs).forEach(([name, value]) => {
+            out += `  --${(0, change_case_1.paramCase)(name)}
+${(0, word_wrap_1.default)(value.doc, { width: 72, indent: '        ' })}
+        Default: ${value.default}\n`;
+        });
+        console.log(out);
+        process.exit(0);
+    }
+    else if (process.argv.findIndex(a => a.localeCompare('--version') === 0) !== -1) {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const version = json5_1.default.parse(fs_1.default.readFileSync((0, utils_1.resolvePackagePath)('package.json')).toString()).version;
+        console.log(version);
+        process.exit(0);
+    }
+}
+async function main() {
+    showHelpOrVersion();
+    const config = (0, config_1.loadConfig)(process.argv[2]);
+    const pids = new Set();
+    await (0, throttle_1.startThrottle)(config.throttleConfig);
+    const stop = async () => {
+        log.info('Stopping...');
+        for (const pid of pids) {
+            const childPids = await (0, utils_1.getProcessChildren)(pid);
+            log.debug(`Killing process ${pid} and children: ${childPids}`);
+            try {
+                process.kill(pid, 'SIGKILL');
+            }
+            catch (err) {
+                log.debug(`Error killing process ${pid}: ${err.stack}`);
+            }
+            for (const childPid of childPids) {
+                try {
+                    process.kill(childPid, 'SIGKILL');
+                }
+                catch (err) {
+                    log.debug(`Error killing child process ${childPid}: ${err.stack}`);
+                }
+            }
+        }
+        await (0, throttle_1.stopThrottle)();
+        process.exit(0);
+    };
+    (0, utils_1.registerExitHandler)(() => stop());
+    const commands = config.commandConfig
+        ? json5_1.default.parse(config.commandConfig)
+        : [];
+    for (const c of commands) {
+        const { session, command } = c;
+        const shortName = command.split(' ')[0];
+        const index = (0, throttle_1.getSessionThrottleIndex)(session || 0);
+        const launcher = await (0, throttle_1.throttleLauncher)(command, index);
+        try {
+            const proc = (0, child_process_1.spawn)(launcher, {
+                shell: false,
+                stdio: ['ignore', 'pipe', 'pipe'],
+                detached: false,
+            });
+            if (proc.pid)
+                pids.add(proc.pid);
+            proc.stdout.on('data', data => {
+                log.info(`[${shortName}][stdout]`, data.toString().trim());
+            });
+            proc.stderr.on('data', data => {
+                log.info(`[${shortName}][stderr]`, data.toString().trim());
+            });
+            proc.on('error', err => {
+                if (err.message.startsWith('The operation was aborted'))
+                    return;
+                log.error(`Error running command "${command}": ${err.stack}`);
+            });
+            proc.once('exit', code => {
+                log.info(`Command "${command}" exited with code: ${code || 0}`);
+                if (proc.pid)
+                    pids.delete(proc.pid);
+                /* fs.promises.unlink(launcher).catch(err => {
+                  log.warn(`Error unlinking "${launcher}": ${(err as Error).stack}`)
+                }) */
+            });
+        }
+        catch (err) {
+            log.error(`Error running command "${command}": ${err.stack}`);
+        }
+    }
+    // Stop after a configured duration.
+    if (config.runDuration > 0) {
+        setTimeout(stop, config.runDuration * 1000);
+    }
+    // Command line interface.
+    console.log('Press [q] to stop the throttler');
+    process.stdin.setRawMode(true);
+    process.stdin.resume();
+    process.stdin.on('data', async (data) => {
+        log.debug('[stdin]', data[0]);
+        if (data[0] === 'q'.charCodeAt(0)) {
+            try {
+                await stop();
+            }
+            catch (err) {
+                log.error(`stop error: ${err.stack}`);
+                process.exit(1);
+            }
+        }
+        else {
+            console.log('Press [q] to stop the throttler');
+        }
+    });
+}
+if (require.main === module) {
+    main().catch(err => {
+        console.error(err);
+        process.exit(-1);
+    });
+}
+//# sourceMappingURL=app.js.map

package/build/src/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":";;;;;AAAA,6CAAuC;AACvC,iDAAqC;AACrC,4CAAmB;AACnB,kDAAyB;AACzB,0DAA4B;AAE5B,qCAAoD;AACpD,yCAKmB;AACnB,mCAKgB;AAEhB,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,WAAW,CAAC,CAAA;AAE/B,SAAS,iBAAiB;IACxB,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACxE,MAAM,IAAI,GAAG,IAAA,sBAAa,GAAE,CAAA;QAC5B,IAAI,GAAG,GAAG,+DAA+D,CAAA;QACzE,8DAA8D;QAC9D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAgB,EAAE,EAAE;YAC5D,GAAG,IAAI,OAAO,IAAA,uBAAS,EAAC,IAAI,CAAC;EACjC,IAAA,mBAAI,EAAC,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;mBACjC,KAAK,CAAC,OAAO,IAAI,CAAA;QAChC,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;SAAM,IACL,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EACtE,CAAC;QACD,8DAA8D;QAC9D,MAAM,OAAO,GAAG,eAAK,CAAC,KAAK,CACzB,YAAE,CAAC,YAAY,CAAC,IAAA,0BAAkB,EAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,CAC/D,CAAC,OAAO,CAAA;QACT,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC;AAOD,KAAK,UAAU,IAAI;IACjB,iBAAiB,EAAE,CAAA;IAEnB,MAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAC1C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;IAE9B,MAAM,IAAA,wBAAa,EAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAE1C,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;QACrC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,SAAS,GAAG,MAAM,IAAA,0BAAkB,EAAC,GAAG,CAAC,CAAA;YAC/C,GAAG,CAAC,KAAK,CAAC,mBAAmB,GAAG,kBAAkB,SAAS,EAAE,CAAC,CAAA;YAC9D,IAAI,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;YAC9B,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACtB,GAAG,CAAC,KAAK,CAAC,yBAAyB,GAAG,KAAM,GAAa,CAAC,KAAK,EAAE,CAAC,CAAA;YACpE,CAAC;YACD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,IAAI,CAAC;oBACH,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;gBACnC,CAAC;gBAAC,OAAO,GAAY,EAAE,CAAC;oBACtB,GAAG,CAAC,KAAK,CACP,+BAA+B,QAAQ,KAAM,GAAa,CAAC,KAAK,EAAE,CACnE,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,MAAM,IAAA,uBAAY,GAAE,CAAA;QACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC,CAAA;IACD,IAAA,2BAAmB,EAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;IAEjC,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa;QACnC,CAAC,CAAE,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAe;QAClD,CAAC,CAAC,EAAE,CAAA;IACN,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACzB,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;QAC9B,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QACvC,MAAM,KAAK,GAAG,IAAA,kCAAuB,EAAC,OAAO,IAAI,CAAC,CAAC,CAAA;QACnD,MAAM,QAAQ,GAAG,MAAM,IAAA,2BAAgB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACvD,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAA,qBAAK,EAAC,QAAQ,EAAE;gBAC3B,KAAK,EAAE,KAAK;gBACZ,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;gBACjC,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAA;YACF,IAAI,IAAI,CAAC,GAAG;gBAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAChC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC5B,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;YAC5D,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC5B,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;YAC5D,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;gBACrB,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;oBAAE,OAAM;gBAC/D,GAAG,CAAC,KAAK,CAAC,0BAA0B,OAAO,MAAO,GAAa,CAAC,KAAK,EAAE,CAAC,CAAA;YAC1E,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBACvB,GAAG,CAAC,IAAI,CAAC,YAAY,OAAO,uBAAuB,IAAI,IAAI,CAAC,EAAE,CAAC,CAAA;gBAC/D,IAAI,IAAI,CAAC,GAAG;oBAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACnC;;qBAEK;YACP,CAAC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACtB,GAAG,CAAC,KAAK,CAAC,0BAA0B,OAAO,MAAO,GAAa,CAAC,KAAK,EAAE,CAAC,CAAA;QAC1E,CAAC;IACH,CAAC;IAED,oCAAoC;IACpC,IAAI,MAAM,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC;QAC3B,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAC7C,CAAC;IAED,0BAA0B;IAC1B,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;IAC9C,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IAC9B,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAA;IACtB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;QACpC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7B,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC;gBACH,MAAM,IAAI,EAAE,CAAA;YACd,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACtB,GAAG,CAAC,KAAK,CAAC,eAAgB,GAAa,CAAC,KAAK,EAAE,CAAC,CAAA;gBAChD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;QAChD,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACjB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAClB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAClB,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import { paramCase } from 'change-case'\nimport { spawn } from 'child_process'\nimport fs from 'fs'\nimport json5 from 'json5'\nimport wrap from 'word-wrap'\n\nimport { getConfigDocs, loadConfig } from './config'\nimport {\n  getSessionThrottleIndex,\n  startThrottle,\n  stopThrottle,\n  throttleLauncher,\n} from './throttle'\nimport {\n  getProcessChildren,\n  logger,\n  registerExitHandler,\n  resolvePackagePath,\n} from './utils'\n\nconst log = logger('throttler')\n\nfunction showHelpOrVersion(): void {\n  if (process.argv.findIndex(a => a.localeCompare('--help') === 0) !== -1) {\n    const docs = getConfigDocs()\n    let out = `Params:\\n  --version\\n        It shows the package version.\\n`\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Object.entries(docs).forEach(([name, value]: [string, any]) => {\n      out += `  --${paramCase(name)}\n${wrap(value.doc, { width: 72, indent: '        ' })}\n        Default: ${value.default}\\n`\n    })\n    console.log(out)\n    process.exit(0)\n  } else if (\n    process.argv.findIndex(a => a.localeCompare('--version') === 0) !== -1\n  ) {\n    // eslint-disable-next-line @typescript-eslint/no-var-requires\n    const version = json5.parse(\n      fs.readFileSync(resolvePackagePath('package.json')).toString(),\n    ).version\n    console.log(version)\n    process.exit(0)\n  }\n}\n\ntype Command = {\n  command: string\n  session?: number\n}\n\nasync function main(): Promise<void> {\n  showHelpOrVersion()\n\n  const config = loadConfig(process.argv[2])\n  const pids = new Set<number>()\n\n  await startThrottle(config.throttleConfig)\n\n  const stop = async (): Promise<void> => {\n    log.info('Stopping...')\n    for (const pid of pids) {\n      const childPids = await getProcessChildren(pid)\n      log.debug(`Killing process ${pid} and children: ${childPids}`)\n      try {\n        process.kill(pid, 'SIGKILL')\n      } catch (err: unknown) {\n        log.debug(`Error killing process ${pid}: ${(err as Error).stack}`)\n      }\n      for (const childPid of childPids) {\n        try {\n          process.kill(childPid, 'SIGKILL')\n        } catch (err: unknown) {\n          log.debug(\n            `Error killing child process ${childPid}: ${(err as Error).stack}`,\n          )\n        }\n      }\n    }\n    await stopThrottle()\n    process.exit(0)\n  }\n  registerExitHandler(() => stop())\n\n  const commands = config.commandConfig\n    ? (json5.parse(config.commandConfig) as Command[])\n    : []\n  for (const c of commands) {\n    const { session, command } = c\n    const shortName = command.split(' ')[0]\n    const index = getSessionThrottleIndex(session || 0)\n    const launcher = await throttleLauncher(command, index)\n    try {\n      const proc = spawn(launcher, {\n        shell: false,\n        stdio: ['ignore', 'pipe', 'pipe'],\n        detached: false,\n      })\n      if (proc.pid) pids.add(proc.pid)\n      proc.stdout.on('data', data => {\n        log.info(`[${shortName}][stdout]`, data.toString().trim())\n      })\n      proc.stderr.on('data', data => {\n        log.info(`[${shortName}][stderr]`, data.toString().trim())\n      })\n      proc.on('error', err => {\n        if (err.message.startsWith('The operation was aborted')) return\n        log.error(`Error running command \"${command}\": ${(err as Error).stack}`)\n      })\n      proc.once('exit', code => {\n        log.info(`Command \"${command}\" exited with code: ${code || 0}`)\n        if (proc.pid) pids.delete(proc.pid)\n        /* fs.promises.unlink(launcher).catch(err => {\n          log.warn(`Error unlinking \"${launcher}\": ${(err as Error).stack}`)\n        }) */\n      })\n    } catch (err: unknown) {\n      log.error(`Error running command \"${command}\": ${(err as Error).stack}`)\n    }\n  }\n\n  // Stop after a configured duration.\n  if (config.runDuration > 0) {\n    setTimeout(stop, config.runDuration * 1000)\n  }\n\n  // Command line interface.\n  console.log('Press [q] to stop the throttler')\n  process.stdin.setRawMode(true)\n  process.stdin.resume()\n  process.stdin.on('data', async data => {\n    log.debug('[stdin]', data[0])\n    if (data[0] === 'q'.charCodeAt(0)) {\n      try {\n        await stop()\n      } catch (err: unknown) {\n        log.error(`stop error: ${(err as Error).stack}`)\n        process.exit(1)\n      }\n    } else {\n      console.log('Press [q] to stop the throttler')\n    }\n  })\n}\n\nif (require.main === module) {\n  main().catch(err => {\n    console.error(err)\n    process.exit(-1)\n  })\n}\n"]}

package/build/src/config.d.ts

@@ -0,0 +1,21 @@
+type ConfigDocs = Record<string, {
+    doc: string;
+    format: string;
+    default: string;
+}>;
+/**
+ * It returns the formatted configuration docs.
+ */
+export declare function getConfigDocs(): ConfigDocs;
+declare const schemaProperties: {
+    runDuration: number;
+    throttleConfig: string;
+    commandConfig: string;
+};
+/** [[include:config.md]] */
+export type Config = typeof schemaProperties;
+/**
+ * Loads the config object.
+ */
+export declare function loadConfig(filePath?: string, values?: any): Config;
+export {};

package/build/src/config.js

@@ -0,0 +1,199 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfigDocs = getConfigDocs;
+exports.loadConfig = loadConfig;
+const convict_1 = __importStar(require("convict"));
+const convict_format_with_validator_1 = require("convict-format-with-validator");
+const fs_1 = require("fs");
+const utils_1 = require("./utils");
+const log = (0, utils_1.logger)('throttler:config');
+const float = {
+    name: 'float',
+    coerce: (v) => parseFloat(v),
+    validate: (v) => {
+        if (!Number.isFinite(v))
+            throw new Error(`Invalid float: ${v}`);
+    },
+};
+const index = {
+    name: 'index',
+    coerce: (v) => v,
+    validate: (v) => {
+        if (typeof v === 'string') {
+            if (v === 'true' || v === 'false' || v === '')
+                return;
+            if (v.indexOf('-') !== -1) {
+                v.split('-').forEach(n => {
+                    if (isNaN(parseInt(n)) || !isFinite(parseInt(n)))
+                        throw new Error(`Invalid index: ${n}`);
+                });
+                return;
+            }
+            if (v.indexOf(',') !== -1) {
+                v.split(',').forEach(n => {
+                    if (isNaN(parseInt(n)) || !isFinite(parseInt(n)))
+                        throw new Error(`Invalid index: ${n}`);
+                });
+                return;
+            }
+            if (isNaN(parseInt(v)) || !isFinite(parseInt(v)))
+                throw new Error(`Invalid index: ${v}`);
+        }
+        else if (typeof v === 'number' || typeof v === 'boolean') {
+            return;
+        }
+        throw new Error(`Invalid index: ${v}`);
+    },
+};
+(0, convict_1.addFormats)({ ipaddress: convict_format_with_validator_1.ipaddress, url: convict_format_with_validator_1.url, float, index });
+// config schema
+const configSchema = (0, convict_1.default)({
+    runDuration: {
+        doc: `If greater than 0, the test will stop after the provided number of \
+seconds.`,
+        format: 'nat',
+        default: 0,
+        env: 'RUN_DURATION',
+        arg: 'run-duration',
+    },
+    throttleConfig: {
+        doc: `A JSON5 string with a valid network throttling configuration. \
+Example: \
+
+  \`\`\`javascript
+  [{
+    sessions: '0-1',
+    device: 'eth0',
+    protocol: 'udp',
+    capture: 'capture.pcap',
+    up: {
+      rate: 1000,
+      delay: 50,
+      loss: 5,
+      queue: 10,
+    },
+    down: [
+      { rate: 2000, delay: 50, loss: 2, queue: 20 },
+      { rate: 1000, delay: 50, loss: 2, queue: 20, at: 60 },
+    ]
+  }]
+  \`\`\`
+The sessions field represents the sessions IDs range that will be affected by the rule, e.g.: "0-10", "2,4" or simply "2". \
+The device, protocol, up, down fields are optional. When device is not set, the default route device will be used. If protocol is specified ('udp' or 'tcp'), \
+only the packets with the specified protocol will be affected by the shaping rules. \
+\
+`,
+        format: String,
+        nullable: true,
+        default: '',
+        env: 'THROTTLE_CONFIG',
+        arg: 'throttle-config',
+    },
+    commandConfig: {
+        doc: `The commands configuration.\
+Example: \
+
+  \`\`\`javascript
+  [{
+    session: 0,
+    command: "firefox https://www.speedtest.net",
+  }]
+  \`\`\`
+`,
+        format: String,
+        nullable: true,
+        default: '',
+        env: 'COMMAND_CONFIG',
+        arg: 'command-config',
+    },
+});
+/**
+ * Formats the schema documentation, calling the same function recursively.
+ * @param docs the documentation object to extend
+ * @param property the root property
+ * @param schema the config schema fragment
+ * @return the documentation object
+ */
+function formatDocs(docs, property, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schema) {
+    if (schema._cvtProperties) {
+        Object.entries(schema._cvtProperties).forEach(([name, value]) => {
+            formatDocs(docs, `${property ? `${property}.` : ''}${name}`, value);
+        });
+        return docs;
+    }
+    if (property) {
+        docs[property] =
+            // eslint-disable-line no-param-reassign
+            {
+                doc: schema.doc,
+                format: JSON.stringify(schema.format, null, 2),
+                default: JSON.stringify(schema.default, null, 2),
+            };
+    }
+    return docs;
+}
+/**
+ * It returns the formatted configuration docs.
+ */
+function getConfigDocs() {
+    return formatDocs({}, null, configSchema.getSchema());
+}
+const schemaProperties = configSchema.getProperties();
+/**
+ * Loads the config object.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function loadConfig(filePath, values) {
+    if (filePath && (0, fs_1.existsSync)(filePath)) {
+        log.debug(`Loading config from ${filePath}`);
+        configSchema.loadFile(filePath);
+    }
+    else if (values) {
+        log.debug('Loading config from values.');
+        configSchema.load(values);
+    }
+    else {
+        log.debug('Using default values.');
+        configSchema.load({});
+    }
+    configSchema.validate({ allowed: 'strict' });
+    const config = configSchema.getProperties();
+    log.debug('Using config:', config);
+    return config;
+}
+//# sourceMappingURL=config.js.map

package/build/src/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoJA,sCAEC;AAWD,gCAiBC;AAlLD,mDAA6C;AAC7C,iFAA8D;AAC9D,2BAA+B;AAE/B,mCAAgC;AAChC,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,kBAAkB,CAAC,CAAA;AAEtC,MAAM,KAAK,GAAG;IACZ,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACpC,QAAQ,EAAE,CAAC,CAAS,EAAE,EAAE;QACtB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;IACjE,CAAC;CACF,CAAA;AAED,MAAM,KAAK,GAAG;IACZ,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC;IACzB,QAAQ,EAAE,CAAC,CAA4B,EAAE,EAAE;QACzC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,MAAM,IAAI,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,EAAE;gBAAE,OAAM;YACrD,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC1B,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;oBACvB,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;wBAC9C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;gBAC1C,CAAC,CAAC,CAAA;gBACF,OAAM;YACR,CAAC;YACD,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC1B,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;oBACvB,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;wBAC9C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;gBAC1C,CAAC,CAAC,CAAA;gBACF,OAAM;YACR,CAAC;YACD,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAC9C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC1C,CAAC;aAAM,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3D,OAAM;QACR,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;IACxC,CAAC;CACF,CAAA;AAED,IAAA,oBAAU,EAAC,EAAE,SAAS,EAAT,yCAAS,EAAE,GAAG,EAAH,mCAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;AAE5C,gBAAgB;AAChB,MAAM,YAAY,GAAG,IAAA,iBAAO,EAAC;IAC3B,WAAW,EAAE;QACX,GAAG,EAAE;SACA;QACL,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,cAAc;QACnB,GAAG,EAAE,cAAc;KACpB;IACD,cAAc,EAAE;QACd,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;CAyBR;QACG,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,EAAE;QACX,GAAG,EAAE,iBAAiB;QACtB,GAAG,EAAE,iBAAiB;KACvB;IACD,aAAa,EAAE;QACb,GAAG,EAAE;;;;;;;;;CASR;QACG,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,EAAE;QACX,GAAG,EAAE,gBAAgB;QACrB,GAAG,EAAE,gBAAgB;KACtB;CACF,CAAC,CAAA;AAOF;;;;;;GAMG;AACH,SAAS,UAAU,CACjB,IAAgB,EAChB,QAAuB;AACvB,8DAA8D;AAC9D,MAAW;IAEX,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9D,UAAU,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,KAAK,CAAC,CAAA;QACrE,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC,QAAQ,CAAC;YACZ,wCAAwC;YACxC;gBACE,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC9C,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;aACjD,CAAA;IACL,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa;IAC3B,OAAO,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,CAAC,CAAA;AACvD,CAAC;AAED,MAAM,gBAAgB,GAAG,YAAY,CAAC,aAAa,EAAE,CAAA;AAKrD;;GAEG;AACH,8DAA8D;AAC9D,SAAgB,UAAU,CAAC,QAAiB,EAAE,MAAY;IACxD,IAAI,QAAQ,IAAI,IAAA,eAAU,EAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,GAAG,CAAC,KAAK,CAAC,uBAAuB,QAAQ,EAAE,CAAC,CAAA;QAC5C,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;SAAM,IAAI,MAAM,EAAE,CAAC;QAClB,GAAG,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QACxC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC3B,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;QAClC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACvB,CAAC;IAED,YAAY,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAA;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,aAAa,EAAE,CAAA;IAE3C,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;IAClC,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import convict, { addFormats } from 'convict'\nimport { ipaddress, url } from 'convict-format-with-validator'\nimport { existsSync } from 'fs'\n\nimport { logger } from './utils'\nconst log = logger('throttler:config')\n\nconst float = {\n  name: 'float',\n  coerce: (v: string) => parseFloat(v),\n  validate: (v: number) => {\n    if (!Number.isFinite(v)) throw new Error(`Invalid float: ${v}`)\n  },\n}\n\nconst index = {\n  name: 'index',\n  coerce: (v: unknown) => v,\n  validate: (v: boolean | string | number) => {\n    if (typeof v === 'string') {\n      if (v === 'true' || v === 'false' || v === '') return\n      if (v.indexOf('-') !== -1) {\n        v.split('-').forEach(n => {\n          if (isNaN(parseInt(n)) || !isFinite(parseInt(n)))\n            throw new Error(`Invalid index: ${n}`)\n        })\n        return\n      }\n      if (v.indexOf(',') !== -1) {\n        v.split(',').forEach(n => {\n          if (isNaN(parseInt(n)) || !isFinite(parseInt(n)))\n            throw new Error(`Invalid index: ${n}`)\n        })\n        return\n      }\n      if (isNaN(parseInt(v)) || !isFinite(parseInt(v)))\n        throw new Error(`Invalid index: ${v}`)\n    } else if (typeof v === 'number' || typeof v === 'boolean') {\n      return\n    }\n    throw new Error(`Invalid index: ${v}`)\n  },\n}\n\naddFormats({ ipaddress, url, float, index })\n\n// config schema\nconst configSchema = convict({\n  runDuration: {\n    doc: `If greater than 0, the test will stop after the provided number of \\\nseconds.`,\n    format: 'nat',\n    default: 0,\n    env: 'RUN_DURATION',\n    arg: 'run-duration',\n  },\n  throttleConfig: {\n    doc: `A JSON5 string with a valid network throttling configuration. \\\nExample: \\\n\n  \\`\\`\\`javascript\n  [{\n    sessions: '0-1',\n    device: 'eth0',\n    protocol: 'udp',\n    capture: 'capture.pcap',\n    up: {\n      rate: 1000,\n      delay: 50,\n      loss: 5,\n      queue: 10,\n    },\n    down: [\n      { rate: 2000, delay: 50, loss: 2, queue: 20 },\n      { rate: 1000, delay: 50, loss: 2, queue: 20, at: 60 },\n    ]\n  }]\n  \\`\\`\\`\nThe sessions field represents the sessions IDs range that will be affected by the rule, e.g.: \"0-10\", \"2,4\" or simply \"2\". \\\nThe device, protocol, up, down fields are optional. When device is not set, the default route device will be used. If protocol is specified ('udp' or 'tcp'), \\\nonly the packets with the specified protocol will be affected by the shaping rules. \\\n\\\n`,\n    format: String,\n    nullable: true,\n    default: '',\n    env: 'THROTTLE_CONFIG',\n    arg: 'throttle-config',\n  },\n  commandConfig: {\n    doc: `The commands configuration.\\\nExample: \\\n\n  \\`\\`\\`javascript\n  [{\n    session: 0,\n    command: \"firefox https://www.speedtest.net\",\n  }]\n  \\`\\`\\`\n`,\n    format: String,\n    nullable: true,\n    default: '',\n    env: 'COMMAND_CONFIG',\n    arg: 'command-config',\n  },\n})\n\ntype ConfigDocs = Record<\n  string,\n  { doc: string; format: string; default: string }\n>\n\n/**\n * Formats the schema documentation, calling the same function recursively.\n * @param docs the documentation object to extend\n * @param property the root property\n * @param schema the config schema fragment\n * @return the documentation object\n */\nfunction formatDocs(\n  docs: ConfigDocs,\n  property: string | null,\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  schema: any,\n): ConfigDocs {\n  if (schema._cvtProperties) {\n    Object.entries(schema._cvtProperties).forEach(([name, value]) => {\n      formatDocs(docs, `${property ? `${property}.` : ''}${name}`, value)\n    })\n    return docs\n  }\n\n  if (property) {\n    docs[property] =\n      // eslint-disable-line no-param-reassign\n      {\n        doc: schema.doc,\n        format: JSON.stringify(schema.format, null, 2),\n        default: JSON.stringify(schema.default, null, 2),\n      }\n  }\n  return docs\n}\n\n/**\n * It returns the formatted configuration docs.\n */\nexport function getConfigDocs(): ConfigDocs {\n  return formatDocs({}, null, configSchema.getSchema())\n}\n\nconst schemaProperties = configSchema.getProperties()\n\n/** [[include:config.md]] */\nexport type Config = typeof schemaProperties\n\n/**\n * Loads the config object.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport function loadConfig(filePath?: string, values?: any): Config {\n  if (filePath && existsSync(filePath)) {\n    log.debug(`Loading config from ${filePath}`)\n    configSchema.loadFile(filePath)\n  } else if (values) {\n    log.debug('Loading config from values.')\n    configSchema.load(values)\n  } else {\n    log.debug('Using default values.')\n    configSchema.load({})\n  }\n\n  configSchema.validate({ allowed: 'strict' })\n  const config = configSchema.getProperties()\n\n  log.debug('Using config:', config)\n  return config\n}\n"]}

package/build/src/generate-config-docs.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/generate-config-docs.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("fs/promises");
+const config_1 = require("./config");
+function formatJson(data) {
+    return `\`${data.replace(/\n/g, '')}\``;
+}
+let data = `
+The configuration properties are applied in the following order (from higher to
+lower precedence):
+
+- arguments passed to the executable in kebab case (e.g. \`--run-duration\`);
+- environment variables in uppercase snake format (e.g. \`RUN_DURATION\`);
+- \`config.json\` configuration file;
+- default values.
+
+`;
+const configDocs = (0, config_1.getConfigDocs)();
+Object.entries(configDocs).forEach(entry => {
+    const [name, value] = entry;
+    data += `\
+## ${name}
+${value.doc}
+
+*Type*: \`${value.format === '"nat"'
+        ? 'positive int'
+        : value.format.replace(/^"(.+)"$/, '$1')}\`
+
+*Default*: ${formatJson(value.default)}
+
+`;
+});
+data += `
+
+---
+
+`;
+(0, promises_1.writeFile)('docs/config.md', data).then(() => {
+    console.log('done'); // eslint-disable-line
+}, err => {
+    console.error(`Error writing file: ${err.message}`); // eslint-disable-line
+});
+//# sourceMappingURL=generate-config-docs.js.map

package/build/src/generate-config-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-config-docs.js","sourceRoot":"","sources":["../../src/generate-config-docs.ts"],"names":[],"mappings":";;AAAA,0CAAuC;AAEvC,qCAAwC;AAExC,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAA;AACzC,CAAC;AAED,IAAI,IAAI,GAAG;;;;;;;;;CASV,CAAA;AAED,MAAM,UAAU,GAAG,IAAA,sBAAa,GAAE,CAAA;AAClC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;IACzC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,KAAK,CAAA;IAC3B,IAAI,IAAI;KACL,IAAI;EACP,KAAK,CAAC,GAAG;;YAGP,KAAK,CAAC,MAAM,KAAK,OAAO;QACtB,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAC3C;;aAEW,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC;;CAErC,CAAA;AACD,CAAC,CAAC,CAAA;AAEF,IAAI,IAAI;;;;CAIP,CAAA;AAED,IAAA,oBAAS,EAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,IAAI,CACpC,GAAG,EAAE;IACJ,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,sBAAsB;AAC5C,CAAC,EACD,GAAG,CAAC,EAAE;IACL,OAAO,CAAC,KAAK,CAAC,uBAAuB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,sBAAsB;AAC5E,CAAC,CACF,CAAA","sourcesContent":["import { writeFile } from 'fs/promises'\n\nimport { getConfigDocs } from './config'\n\nfunction formatJson(data: string): string {\n  return `\\`${data.replace(/\\n/g, '')}\\``\n}\n\nlet data = `\nThe configuration properties are applied in the following order (from higher to\nlower precedence):\n\n- arguments passed to the executable in kebab case (e.g. \\`--run-duration\\`);\n- environment variables in uppercase snake format (e.g. \\`RUN_DURATION\\`);\n- \\`config.json\\` configuration file;\n- default values.\n\n`\n\nconst configDocs = getConfigDocs()\nObject.entries(configDocs).forEach(entry => {\n  const [name, value] = entry\n  data += `\\\n## ${name}\n${value.doc}\n\n*Type*: \\`${\n    value.format === '\"nat\"'\n      ? 'positive int'\n      : value.format.replace(/^\"(.+)\"$/, '$1')\n  }\\`\n\n*Default*: ${formatJson(value.default)}\n\n`\n})\n\ndata += `\n\n---\n\n`\n\nwriteFile('docs/config.md', data).then(\n  () => {\n\t  console.log('done'); // eslint-disable-line\n  },\n  err => {\n\t  console.error(`Error writing file: ${err.message}`); // eslint-disable-line\n  },\n)\n"]}

package/build/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './app';
+export * from './config';
+export * from './throttle';
+export * from './utils';

package/build/src/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./app"), exports);
+__exportStar(require("./config"), exports);
+__exportStar(require("./throttle"), exports);
+__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAqB;AACrB,2CAAwB;AACxB,6CAA0B;AAC1B,0CAAuB","sourcesContent":["export * from './app'\nexport * from './config'\nexport * from './throttle'\nexport * from './utils'\n"]}

package/build/src/throttle.d.ts

@@ -0,0 +1,85 @@
+/** The network throttle rules to be applied to uplink or downlink. */
+export type ThrottleRule = {
+    /** The available bandwidth (Kbps). */
+    rate?: number;
+    /** The one-way delay (ms). */
+    delay?: number;
+    /** The one-way delay jitter (ms). */
+    delayJitter?: number;
+    /** The one-way delay jitter correlation. */
+    delayJitterCorrelation?: number;
+    /** The delay distribution. */
+    delayDistribution?: 'uniform' | 'normal' | 'pareto' | 'paretonormal';
+    /** The packet reordering percentage. */
+    reorder?: number;
+    /** The packet reordering correlation. */
+    reorderCorrelation?: number;
+    /** The packet reordering gap. */
+    reorderGap?: number;
+    /** The packet loss percentage. */
+    loss?: number;
+    /** The packet loss burst. */
+    lossBurst?: number;
+    /** The packet queue size. */
+    queue?: number;
+    /** If set, the rule will be applied after the specified number of seconds. */
+    at?: number;
+};
+/**
+ * The network throttling rules.
+ * Specify multiple {@link ThrottleRule} with different `at` values to schedule
+ * network bandwidth/delay fluctuations during the test run, e.g.:
+ *
+ * ```javascript
+ * {
+    device: "eth0",
+    sessions: "0-1",
+    protocol: "udp",
+    down: [
+      { rate: 1000000, delay: 50, loss: 0, queue: 5 },
+      { rate: 200000, delay: 100, loss: 5, queue: 5, at: 60},
+    ],
+    up: { rate: 100000, delay: 50, queue: 5 },
+    capture: 'capture.pcap',
+  }
+ * ```
+ */
+export type ThrottleConfig = {
+    /** The network interface to throttle. If not specified, the default interface will be used. */
+    device?: string;
+    /** The sessions to throttle. It could be a single index ("0"), a range ("0-2") or a comma-separated list ("0,3,4"). */
+    sessions?: string;
+    /** The protocol to throttle. */
+    protocol?: 'udp' | 'tcp';
+    /** A comma-separated list of source ports that will not be throttled. */
+    skipSourcePorts?: string;
+    /** A comma-separated list of destination ports that will not be throttled. */
+    skipDestinationPorts?: string;
+    /** An additional IPTables packet filter rule. */
+    filter?: string;
+    /** An additional TC match expression used to filter packets (https://man7.org/linux/man-pages/man8/tc-ematch.8.html). */
+    match?: string;
+    /** If set, the packets matching the provided session and protocol will be captured at that file location. */
+    capture?: string;
+    /** The uplink throttle rules. */
+    up?: ThrottleRule | ThrottleRule[];
+    /** The downlink throttle rules. */
+    down?: ThrottleRule | ThrottleRule[];
+};
+/**
+ * Starts a network throttle configuration
+ * @param config A JSON5 configuration parsed as {@link ThrottleConfig}.
+ */
+export declare function startThrottle(config: string): Promise<void>;
+/**
+ * Stops the network throttle.
+ */
+export declare function stopThrottle(): Promise<void>;
+export declare function getSessionThrottleIndex(sessionId: number): number;
+export declare function getSessionThrottleValues(index: number, direction: 'up' | 'down'): {
+    rate?: number;
+    delay?: number;
+    loss?: number;
+    queue?: number;
+};
+export declare function throttleLauncher(executablePath: string, index: number): Promise<string>;