Implement toIncludeAllPartialMembers

[ibarsi]

What

Implement toIncludeAllPartialMembers matcher.

Why

Consider the following test:

test('passes when given array values match the partial members of the set', () => {
  expect([{ foo: 'bar', baz: 'qux' }]).toIncludeAllMembers([{ foo: 'bar' }]);
});

I would like to assert that the provided array's objects partially contain all properties of the provided members. Currently, toIncludeAllMembers is the closest available matcher but it's too strict on matching the exact shape of each member.

What I need is the matcher to ignore additional properties and only partially match against the provided members.

Notes

• As an alternative to a net new matcher, we could extend toIncludeAllMembers to accept an options object (e.g. { isPartial: true }) that would configure the matcher to either partially or fully test for equality.
• toIncludeAnyPartialMembers would be another potentially useful matcher, but I wanted to keep this PR small and focused.

Housekeeping

• Unit tests
• Documentation is up to date
• No additional lint warnings
• Add yourself to contributors list (yarn contributor)
• Typescript definitions are added/updated where relevant

[codecov-io]

Codecov Report

Merging #210 (c1fc115) into main (adb82b8) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #210   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          123       125    +2     
  Lines          761       774   +13     
  Branches       111       115    +4     
=========================================
+ Hits           761       774   +13     

Impacted Files	Coverage Δ
src/matchers/index.js	100.00% <100.00%> (ø)
src/matchers/toIncludeAllPartialMembers/index.js	100.00% <100.00%> (ø)
...c/matchers/toIncludeAllPartialMembers/predicate.js	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update adb82b8...c1fc115. Read the comment docs.

[ibarsi]

Bump, curious if anyone’s had the chance to look into this yet? 🙂

[ispyinternet]

I would like this.

[jadbox]

@ibarsi Pretty please add toIncludeAnyPartialMembers to this PR... it would resolve this old request of mine: #146

[mooseburgr]

Bumping this as well. Any concerns with adding and releasing this? (Besides the request to throw in a toIncludeAnyPartialMembers on PR as well.)

[jbjhjm]

Bump, this is a useful new piece for jest-extended and I'm sad to see the pull request is waiting for almost 2 years now!

[SimenB]

thanks!