Documentation
    Preparing search index...

    Interface MockSoulseekOptions

    Factory options for the soulseek mock.

    const service = createMockSoulseekService({ accountState: 'offline' });
    interface MockSoulseekOptions {
        accountState?: "online" | "unconfigured" | "offline";
        autoplay?: boolean;
        batchSize?: number;
        canSave?: boolean;
        clock?: MockClock;
        latencyMs?: number;
        maxResults?: number;
        readsAuthorized?: boolean;
        scheduler?: MockScheduler;
        seed?: number;
        tickMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accountState? autoplay? batchSize? canSave? clock? latencyMs? maxResults? readsAuthorized? scheduler? seed? tickMs?

    Properties

    accountState?: "online" | "unconfigured" | "offline"

    Shell account availability. Default online.

    autoplay?: boolean

    Run advance() every tickMs while work is pending. Default false.

    batchSize?: number

    Results appended per advance() step. Default 3.

    canSave?: boolean

    Whether save is implemented. Default true.

    clock?: MockClock

    Clock used for timestamps. Default: Date.now.

    latencyMs?: number

    Artificial latency (ms) applied before each result. Default 0, which responds synchronously inside handleMessage.

    maxResults?: number

    Override maxResults (default 500).

    readsAuthorized?: boolean

    Whether read disclosure is granted. Default true.

    scheduler?: MockScheduler

    Scheduler used for deferred pushes. Default: setTimeout.

    seed?: number

    Seed for deterministic ids and fixture ordering. Default 1.

    tickMs?: number

    Autoplay interval in ms. Default 250.

    Settings

    Member Visibility

    On This Page

    Properties