Function createToHaveBeenCalledMatcher

packages/expect/src/spyMatchers.ts:359–412

()

};

const createToHaveBeenCalledMatcher = (): MatcherFunction<[unknown]> =>
  function (received: any, expected: unknown): SyncExpectationResult {
    const expectedArgument = '';
    const options: MatcherHintOptions = {
      isNot: this.isNot,
      promise: this.promise,
    };
    ensureNoExpected(expected, 'toHaveBeenCalled', options);
    ensureMockOrSpy(received, 'toHaveBeenCalled', expectedArgument, options);

    const receivedIsSpy = isSpy(received);
    const receivedName = receivedIsSpy ? 'spy' : received.getMockName();
    const count = receivedIsSpy
      ? received.calls.count()
      : received.mock.calls.length;
    const calls = receivedIsSpy
      ? received.calls.all().map((x: any) => x.args)
      : received.mock.calls;
    const pass = count > 0;
    const message = pass
      ? () =>
          // eslint-disable-next-line prefer-template
          matcherHint(
            'toHaveBeenCalled',
            receivedName,
            expectedArgument,
            options,
          ) +
          '\n\n' +
          `Expected number of calls: ${printExpected(0)}\n` +
          `Received number of calls: ${printReceived(count)}\n\n` +
          calls
            .reduce((lines: Array<string>, args: any, i: number) => {
              if (lines.length < PRINT_LIMIT) {
                lines.push(`${i + 1}: ${printReceivedArgs(args)}`);
              }

              return lines;
            }, [])
            .join('\n')
      : () =>
          // eslint-disable-next-line prefer-template
          matcherHint(
            'toHaveBeenCalled',
            receivedName,
            expectedArgument,
            options,
          ) +
          '\n\n' +
          `Expected number of calls: >= ${printExpected(1)}\n` +
          `Received number of calls:    ${printReceived(count)}`;

    return {message, pass};
  };

const createToHaveReturnedMatcher = (): MatcherFunction<[unknown]> =>
  function (received: any, expected): SyncExpectationResult {