Skip to content

Commit d8044cd

Browse files
Update docs.
1 parent b26c9fe commit d8044cd

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

website/docs/matchers/Array.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ Use `.toIncludeAllMembers` when checking if an `Array` contains all of the same
3737
});`}
3838
</TestFile>
3939

40+
### .toIncludeAllMembersInOrder([members])
41+
42+
Use `.toIncludeAllMembersInOrder` when checking if an `Array` contains all of the same members of a given ordered set in the same order.
43+
44+
<TestFile name="toIncludeAllMembersInOrder">
45+
{`test('passes when given array values match the members and order of the ordered set', () => {
46+
expect([1, 2, 3]).toIncludeAllMembersInOrder([1, 2, 3]);
47+
expect([{ foo: 'bar', }, { baz: 'qux' }]).toIncludeAllMembersInOrder([{ foo: 'bar' }, { baz: 'qux' }]);
48+
});`}
49+
</TestFile>
50+
4051
### .toIncludeAllPartialMembers([members])
4152

4253
Use `.toIncludeAllPartialMembers` when checking if an `Array` contains all of the same partial members of a given set.

website/docs/matchers/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ sidebar_position: 1
1616
- [.toBeArray()](/docs/matchers/array/#tobearray)
1717
- [.toBeArrayOfSize()](/docs/matchers/array/#tobearrayofsize)
1818
- [.toIncludeAllMembers([members])](/docs/matchers/array/#toincludeallmembersmembers)
19+
- [.toIncludeAllMembersInOrder([members])](/docs/matchers/array/#toincludeallmembersmembersinorder)
1920
- [.toIncludeAllPartialMembers([members])](/docs/matchers/array/#toincludeallpartialmembersmembers)
2021
- [.toIncludeAnyMembers([members])](/docs/matchers/array/#toincludeanymembersmembers)
2122
- [.toIncludeSameMembers([members])](/docs/matchers/array/#toincludesamemembersmembers)

0 commit comments

Comments
 (0)