[feature] Custom static matchers

[aymericbouzy]

Do you want to request a feature or report a bug?

feature

My need

I'm trying to assert that an object has 2 keys where values are Date-like objects at a specific time (in this case, using moment).

This is my best solution at the moment:

const period = {
  start: moment("2018-05-17"),
  end: moment("2018-05-18"),
}
expect(period).toEqual({
  start: expect.any(Object),
  end: expect.any(Object),
})
expect(period.start.isSame(moment("2018-05-17"))).toBe(true)
expect(period.end.isSame(moment("2018-05-18"))).toBe(true)

What I would like my code to look like

const period = {
  start: moment("2018-05-17"),
  end: moment("2018-05-18"),
}
expect(period).toEqual({
  start: expect.sameDate("2018-05-17"),
  end: expect.sameDate("2018-05-18"),
})

Suggested API

It is already possible to extend matchers in this way :

expect.extend({
  sameDate(received, expected) {
    ...
  },
})
expect(period.start).sameDate("2018-05-17")

If it could also add the method sameDate to the expect object, everything would work out for me 🎉

PS: thanks for all the amazing work ❤️

[SimenB]

Duplicate of #4711. PR welcome!

[aymericbouzy]

@SimenB I've not contributed to the repo yet : do you feel like it's a good first task?

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.