A matcher that checks that two arrays contain the same elements

[denizdogan]

Feature Request

Description: A matcher that checks that two arrays contain the same elements. Examples:

expect([1, 2]).toMatchArray([2, 1]) // order doesn't matter!
expect([1, 2, 2]).toMatchArray([2, 1, 2]) // same number of 2s, all good
expect([1, 2]).not.toMatchArray([1, 2, 2]) // one extra 2, FAIL
expect([1, 2, 2]).not.toMatchArray([1, 2]) // one extra 2, FAIL

Possible solution: Given arrays A and B, check that they are equal in length. For each element in A, check that the element is equal to any element in B. If it is, remove the element from both arrays. Loop until both arrays are empty.

[mattphillips]

Hey @denizdogan

I like the sounds of this matcher! I'm not too sure about the name though, as toMatchArray sounds like it would need to be identical in terms of order.

How about something like .toIncludeValues([values])?

jest-extended currently has similar APIs in .toIncludeAllMembers([members]) and .toIncludeAnyMembers([members]) which can be used for reference in terms of structuring the matcher.

How would you feel about sending a PR for this?

[denizdogan]

@mattphillips Yeah, I'm not sure what to call it, .toIncludeValues isn't 100% accurate either, it sounds like that's the same as .toIncludeAllMembers to me! :)

Maybe .toEqualMembers? It's hard to describe the matcher concisely. Sure, I can make a PR for this!

[mattphillips]

@denizdogan sorry missed the notification on this! I say lets just start a PR and we can decide on a name after 😆

[denizdogan]

@mattphillips Yeah, I'll start working on the PR today or tomorrow, I just had a lot of things to take care of IRL 👍

[mattphillips]

merged in #122

[trev-gulls]

Is this issue closed? I still have the following error in jest 26.6.3

Error: expect(received).toContainEqual(expected) // deep equality

Expected value: [0, 1]
Received array: [0, 1]

[AyobamiH]

I just started learning jest and I have been bashing my head against the keyboard before finding this, I still suffer from not being able to solve the issue off

Error: expect(received).toContainEqual(expected) // deep equality