universal-speedtest/dist/esm/index.js

Test your network speed using Ookla speedtest.

import { DistanceUnits, SpeedUnits } from "./interfaces/index.js";
import { convertSpeedUnit } from "./utils/index.js";
import { Ookla } from "./tests/index.js";
/**
 * UniversalSpeedTest.
 */
export class UniversalSpeedTest {
    options;
    /**
     * Constructor for UniversalSpeedTest.
     * @param options - UniversalSpeedTest options object
     */
    constructor(options) {
        this.options = {
            debug: false,
            ...options,
            tests: {
                measureDownload: true,
                measureUpload: false,
                ...options?.tests
            },
            units: {
                distanceUnit: DistanceUnits.mi,
                downloadUnit: SpeedUnits.Mbps,
                uploadUnit: SpeedUnits.Mbps,
                ...options?.units
            },
            ooklaOptions: {
                serversToFetch: 10,
                connections: "multi",
                technology: "http",
                ...options?.ooklaOptions
            }
        };
    }
    /**
     * Lists Ookla test servers.
     * @param serversToFetch - Number of test servers to fetch
     * @returns {Promise<OAServer[]>} Ookla test servers
     */
    listOoklaServers(serversToFetch) {
        const ooklaTest = new Ookla(this.options);
        return ooklaTest.listServers(serversToFetch);
    }
    /**
     * Searches Ookla test servers based on search term.
     * @param searchTerm - Search term
     * @param serversToFetch - Number of test servers to fetch
     * @returns {Promise<OAServer[]>} Ookla test servers
     */
    searchOoklaServers(searchTerm, serversToFetch) {
        const ooklaTest = new Ookla(this.options);
        return ooklaTest.searchServers(searchTerm, serversToFetch);
    }
    /**
     * Performs speedtest using Ookla servers.
     * @param server - Test server to be used for measurement
     * @returns {Promise<OAResult>} Ookla test result
     */
    performOoklaTest(server) {
        const ooklaTest = new Ookla(this.options);
        return ooklaTest.runTest(server);
    }
}
export { DistanceUnits, SpeedUnits, convertSpeedUnit };