Function stubSpinner

  • stubSpinner(sandbox): {
        start: SinonStub<[action: string, status?: string, opts?: {
            stdout?: boolean;
        }], void>;
        stop: SinonStub<[msg?: string], void>;
    }

  • Stub the SfCommand spinner. Even if you plan to make no assertions, this will silence the output to keep your test results clean

    Parameters

    • sandbox: SinonSandbox

    Returns {
        start: SinonStub<[action: string, status?: string, opts?: {
            stdout?: boolean;
        }], void>;
        stop: SinonStub<[msg?: string], void>;
    }

    • start: SinonStub<[action: string, status?: string, opts?: {
          stdout?: boolean;
      }], void>
    • stop: SinonStub<[msg?: string], void>

    Example

    import { stubSpinner } from '@salesforce/sf-plugins-core';
    let spinnerStubs: ReturnType<typeof stubSpinner>;

    // inside your beforeEach, $$ is a SinonSandbox
    spinnerStubs = stubSpinner($$.SANDBOX);

    // inside some test
    expect(spinnerStubs.callCount).equals(1);

Settings

Member Visibility