Function stubUx

  • stubUx(sandbox): {
        log: SinonStub<[message?: string, ...args: string[]], void>;
        styledHeader: SinonStub<[text: string], void>;
        styledJSON: SinonStub<[obj: AnyJson, theme?: Record<string, string>], void>;
        styledObject: SinonStub<[obj: AnyJson, keys?: string[]], void>;
        table: SinonStub<[options: TableOptions<Record<string, unknown>>], void>;
        url: SinonStub<[text: string, uri: string, params: {}], void>;
        warn: SinonStub<[message: string | Error], void>;
    }

  • Stub methods on the Ux class. Even if you plan to make no assertions, this will silence the output to keep your test results clean

    Parameters

    • sandbox: SinonSandbox

    Returns {
        log: SinonStub<[message?: string, ...args: string[]], void>;
        styledHeader: SinonStub<[text: string], void>;
        styledJSON: SinonStub<[obj: AnyJson, theme?: Record<string, string>], void>;
        styledObject: SinonStub<[obj: AnyJson, keys?: string[]], void>;
        table: SinonStub<[options: TableOptions<Record<string, unknown>>], void>;
        url: SinonStub<[text: string, uri: string, params: {}], void>;
        warn: SinonStub<[message: string | Error], void>;
    }

    • log: SinonStub<[message?: string, ...args: string[]], void>
    • styledHeader: SinonStub<[text: string], void>
    • styledJSON: SinonStub<[obj: AnyJson, theme?: Record<string, string>], void>
    • styledObject: SinonStub<[obj: AnyJson, keys?: string[]], void>
    • table: SinonStub<[options: TableOptions<Record<string, unknown>>], void>
    • url: SinonStub<[text: string, uri: string, params: {}], void>
    • warn: SinonStub<[message: string | Error], void>

    Example

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

    // inside your beforeEach, $$ is a SinonSandbox
    stubUxStubs = stubUx($$.SANDBOX);

    // inside some test
    expect(stubUxStubs.log.args.flat()).to.deep.include(`foo`);

Settings

Member Visibility