Function toMatchSnapshot

packages/jest-snapshot/src/index.ts:160–212

(received, propertiesOrHint, hint)

  Context,
  [propertiesOrHint?: object | string, hint?: string]
> = function (received, propertiesOrHint, hint) {
  const matcherName = class="st">'toMatchSnapshot';
  let properties;

  const length = arguments.length;
  if (length === 2 && typeof propertiesOrHint === class="st">'string') {
    hint = propertiesOrHint;
  } else if (length >= 2) {
    if (typeof propertiesOrHint !== class="st">'object' || propertiesOrHint === null) {
      const options: MatcherHintOptions = {
        isNot: this.isNot,
        promise: this.promise,
      };
      let printedWithType = printWithType(
        class="st">'Expected properties',
        propertiesOrHint,
        printExpected,
      );

      if (length === 3) {
        options.secondArgument = class="st">'hint';
        options.secondArgumentColor = BOLD_WEIGHT;

        if (propertiesOrHint == null) {
          printedWithType +=
            class="st">"\n\nTo provide a hint without properties: toMatchSnapshot('hint')";
        }
      }

      throw new Error(
        matcherErrorMessage(
          matcherHint(matcherName, undefined, PROPERTIES_ARG, options),
          `Expected ${EXPECTED_COLOR(class="st">'properties')} must be an object`,
          printedWithType,
        ),
      );
    }

    class="cm">// Future breaking change: Snapshot hint must be a string
    class="cm">// if (arguments.length === 3 && typeof hint !== class="st">'string') {}

    properties = propertiesOrHint;
  }

  return _toMatchSnapshot({
    context: this,
    hint,
    isInline: false,
    matcherName,
    properties,
    received,
  });
};

export const toMatchInlineSnapshot: MatcherFunctionWithContext<
  Context,