Documentation
    Preparing search index...

    Interface MockValueOptions

    Factory options for the value mock.

    const service = createMockValueService({ balanceSats: 50_000, settleMs: 10 });
    interface MockValueOptions {
        autoApprove?: boolean;
        balanceSats?: number;
        clock?: MockClock;
        latencyMs?: number;
        maxAmountMsat?: number;
        rails?: readonly string[];
        scheduler?: MockScheduler;
        seed?: number;
        settleMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoApprove? balanceSats? clock? latencyMs? maxAmountMsat? rails? scheduler? seed? settleMs?

    Properties

    autoApprove?: boolean

    Consent decision when approveNext has nothing queued. Default true.

    balanceSats?: number

    Seeded wallet balance in satoshis. Default 100000.

    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.

    maxAmountMsat?: number

    Per-transfer policy cap in millisatoshis. Default 100000000 (100k sats).

    rails?: readonly string[]

    Rails the shell supports. Default ['zap', 'lnurl'].

    scheduler?: MockScheduler

    Scheduler used for deferred pushes. Default: setTimeout.

    seed?: number

    Seed for deterministic ids and fixture ordering. Default 1.

    settleMs?: number

    When set, settle each pending transfer after this many ms via the scheduler.

    Settings

    Member Visibility

    On This Page

    Properties