import { desc, repr } from "../../describe/describe.js";
import { createMatcher } from "../../match/match.js";
import type {
  ObjectWithProperty,
  ObjectWithPropertyMatcher,
} from "./object-has-property.type.js";

/**
 * Matcher for an object with a certain named property.
 * The property only has to exist on the object, but could be undefined.
 */
export function objectWithProperty<K extends PropertyKey>(
  key: K,
): ObjectWithPropertyMatcher<K> {
  return createMatcher(
    (value): value is ObjectWithProperty<K> =>
      typeof value === "object" && value !== null && key in value,
    () => `object with property ${desc(key)}`,
    () => `{${repr(key)}}`,
  ) as ObjectWithPropertyMatcher<K>;
}