.toHaveProperty(keyPath, value)

Use .toHaveProperty to check if property at provided reference keyPath exists for an object. For checking deeply nested properties in an object you may use dot notation or an array containing the keyPath for deep references.

Optionally, you can provide a value to check if it's equal to the value present at keyPath on the target object. This matcher uses 'deep equality' (like toEqual()) and recursively checks the equality of all fields.

The following example contains a houseForSale object with nested properties. We are using toHaveProperty to check for the existence and values of various properties in the object.

  1. // Object containing house features to be tested
  2. const houseForSale = {
  3.   bath: true,
  4.   bedrooms: 4,
  5.   kitchen: {
  6.     amenities: ['oven', 'stove', 'washer'],
  7.     area: 20,
  8.     wallColor: 'white',
  9.     'nice.oven': true,
  10.   },
  11.   'ceiling.height': 2,
  12. };
  14. test('this house has my desired features', () => {
  15.   // Simple Referencing
  16.   expect(houseForSale).toHaveProperty('bath');
  17.   expect(houseForSale).toHaveProperty('bedrooms', 4);
  19.   expect(houseForSale).not.toHaveProperty('pool');
  21.   // Deep referencing using dot notation
  22.   expect(houseForSale).toHaveProperty('kitchen.area', 20);
  23.   expect(houseForSale).toHaveProperty('kitchen.amenities', [
  24.     'oven',
  25.     'stove',
  26.     'washer',
  27.   ]);
  29.   expect(houseForSale).not.toHaveProperty('kitchen.open');
  31.   // Deep referencing using an array containing the keyPath
  32.   expect(houseForSale).toHaveProperty(['kitchen', 'area'], 20);
  33.   expect(houseForSale).toHaveProperty(
  34.     ['kitchen', 'amenities'],
  35.     ['oven', 'stove', 'washer'],
  36.   );
  37.   expect(houseForSale).toHaveProperty(['kitchen', 'amenities', 0], 'oven');
  38.   expect(houseForSale).toHaveProperty(['kitchen', 'nice.oven']);
  39.   expect(houseForSale).not.toHaveProperty(['kitchen', 'open']);
  41.   // Referencing keys with dot in the key itself
  42.   expect(houseForSale).toHaveProperty(['ceiling.height'], 'tall');
  43. });