Question 1

How to cancel a speed test using speedtest-net?

Accepted Answer

Use the makeCancel() function to create a canceler, pass it in the options via the cancel property, and call it to abort the test. The promise will reject with an error, as shown in the README example for programmatic control.

Question 2

Does speedtest-net work in Docker containers?

Accepted Answer

Yes, but ensure the container has network access and sufficient permissions to download and execute the Ookla binary. You may need to accept licenses programmatically using the acceptLicense option or pre-install the binary.

Question 3

How can I test a specific network interface with speedtest-net?

Accepted Answer

Use the sourceIp option in the module or the --source-ip flag in the CLI to bind the test to a specific IP address, which identifies the desired network interface for targeted performance checks.

Question 4

What's the difference between speedtest-net and fast-cli for Node.js speed testing?

Accepted Answer

speedtest-net uses the official Ookla engine for accuracy and detailed metrics like jitter and packet loss, while fast-cli uses Netflix's fast.com for simpler, faster checks. Choose speedtest-net for official results and event-driven control, fast-cli for quick, lightweight tests.

Question 5

How do I handle progress events in speedtest-net?

Accepted Answer

Pass a progress function in the options to receive real-time events. Each event has a type (e.g., 'download') and progress data, allowing you to update UIs or log details, as detailed in the README with example event structures.

Question 6

Can I run speedtest-net without accepting the license?

Accepted Answer

No, the license must be accepted at least once on the system. Use --accept-license in the CLI or acceptLicense: true in the module; otherwise, you'll get an error with links to the agreements, as noted in the README considerations.

Question 7

Is speedtest-net suitable for continuous monitoring in CI/CD?

Accepted Answer

Yes, its event-driven API and cancellation support make it good for automated scripts. However, plan for binary download permissions and license acceptance to avoid failures in headless environments like CI/CD pipelines.

speedtest-net

What is speedtest-net?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions