@edgible-team/sdk
    Preparing search index...

    Interface BenchmarkOptions

    Options for BenchmarkRunner.run.

    interface BenchmarkOptions {
        cleanup?: boolean;
        deviceId: string;
        flavours?: BenchmarkFlavour[];
        gatewayIds?: string[];
        onProgress?: (event: BenchmarkProgressEvent) => void;
        organizationId: string;
        pollIntervalMs?: number;
        ports?: BenchmarkPorts;
        timeoutMs?: number;
    }
    Index

    Properties

    cleanup? deviceId flavours? gatewayIds? onProgress? organizationId pollIntervalMs? ports? timeoutMs?

    Properties

    cleanup?: boolean

    Delete the created applications at the end; default true.

    deviceId: string

    Serving device to deploy the benchmark applications onto.

    flavours?: BenchmarkFlavour[]

    Which flavours to run; default all three, in order.

    gatewayIds?: string[]

    Self-hosted gateway IDs; omit (or pass []) to use the managed gateway.

    onProgress?: (event: BenchmarkProgressEvent) => void

    Called on every phase transition (replaces the CLI's stdout updates).

    organizationId: string
    pollIntervalMs?: number

    Poll interval between status checks; default 5 000 ms.

    ports?: BenchmarkPorts

    Per-flavour workload port overrides.

    timeoutMs?: number

    Per-phase timeout; default 300 000 ms (the CLI's 300 s default).

    Settings

    Member Visibility

    On This Page

    Properties