Documentation
    Preparing search index...

    Interface MockUploadOptions

    Options for createMockUploadService.

    const service = createMockUploadService({ staged: true, progressSteps: 4 });
    interface MockUploadOptions {
        autoAdvanceMs?: number;
        clock?: MockClock;
        defaultRail?: UploadRail;
        latencyMs?: number;
        maxBytes?: number;
        mimeTypes?: readonly string[];
        progressSteps?: number;
        rails?: readonly UploadRailInfo[];
        scheduler?: MockScheduler;
        seed?: number;
        staged?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoAdvanceMs? clock? defaultRail? latencyMs? maxBytes? mimeTypes? progressSteps? rails? scheduler? seed? staged?

    Properties

    autoAdvanceMs?: number

    When set, staged uploads advance automatically every this many ms.

    clock?: MockClock

    Clock used for timestamps. Default: Date.now.

    defaultRail?: UploadRail

    Rail used when a request omits rail. Default blossom.

    latencyMs?: number

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

    maxBytes?: number

    Enforced and advertised size cap. Default 100 MiB.

    mimeTypes?: readonly string[]

    Accepted MIME types; omit to accept everything.

    progressSteps?: number

    Progress steps for staged uploads. Default 3.

    rails?: readonly UploadRailInfo[]

    Advisory rails. Default DEFAULT_UPLOAD_RAILS.

    scheduler?: MockScheduler

    Scheduler used for deferred pushes. Default: setTimeout.

    seed?: number

    Seed for deterministic ids and fixture ordering. Default 1.

    staged?: boolean

    Report uploading first and progress through advance(). Default latencyMs > 0.

    Settings

    Member Visibility

    On This Page

    Properties