Skip to content

Commit 31ded0c

Browse files
committed
docs(expect): link to matcher docs
1 parent abdecb3 commit 31ded0c

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

expect/mod.ts

+41-41
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,53 @@
77
*
88
* Currently this module supports the following functions:
99
* - Common matchers:
10-
* - `toBe`
11-
* - `toEqual`
12-
* - `toStrictEqual`
13-
* - `toMatch`
14-
* - `toMatchObject`
15-
* - `toBeDefined`
16-
* - `toBeUndefined`
17-
* - `toBeNull`
18-
* - `toBeNaN`
19-
* - `toBeTruthy`
20-
* - `toBeFalsy`
21-
* - `toContain`
22-
* - `toContainEqual`
23-
* - `toHaveLength`
24-
* - `toBeGreaterThan`
25-
* - `toBeGreaterThanOrEqual`
26-
* - `toBeLessThan`
27-
* - `toBeLessThanOrEqual`
28-
* - `toBeCloseTo`
29-
* - `toBeInstanceOf`
30-
* - `toThrow`
31-
* - `toHaveProperty`
32-
* - `toHaveLength`
10+
* - [`toBe`](./doc/~/Expected.toBe)
11+
* - [`toEqual`](./doc/~/Expected.toEqual)
12+
* - [`toStrictEqual`](./doc/~/Expected.toStrictEqual)
13+
* - [`toMatch`](./doc/~/Expected.toMatch)
14+
* - [`toMatchObject`](./doc/~/Expected.toMatchObject)
15+
* - [`toBeDefined`](./doc/~/Expected.toBeDefined)
16+
* - [`toBeUndefined`](./doc/~/Expected.toBeUndefined)
17+
* - [`toBeNull`](./doc/~/Expected.toBeNull)
18+
* - [`toBeNaN`](./doc/~/Expected.toBeNaN)
19+
* - [`toBeTruthy`](./doc/~/Expected.toBeTruthy)
20+
* - [`toBeFalsy`](./doc/~/Expected.toBeFalsy)
21+
* - [`toContain`](./doc/~/Expected.toContain)
22+
* - [`toContainEqual`](./doc/~/Expected.toContainEqual)
23+
* - [`toHaveLength`](./doc/~/Expected.toHaveLength)
24+
* - [`toBeGreaterThan`](./doc/~/Expected.toBeGreaterThan)
25+
* - [`toBeGreaterThanOrEqual`](./doc/~/Expected.toBeGreaterThanOrEqual)
26+
* - [`toBeLessThan`](./doc/~/Expected.toBeLessThan)
27+
* - [`toBeLessThanOrEqual`](./doc/~/Expected.toBeLessThanOrEqual)
28+
* - [`toBeCloseTo`](./doc/~/Expected.toBeCloseTo)
29+
* - [`toBeInstanceOf`](./doc/~/Expected.toBeInstanceOf)
30+
* - [`toThrow`](./doc/~/Expected.toThrow)
31+
* - [`toHaveProperty`](./doc/~/Expected.toHaveProperty)
32+
* - [`toHaveLength`](./doc/~/Expected.toHaveLength)
3333
* - Mock related matchers:
34-
* - `toHaveBeenCalled`
35-
* - `toHaveBeenCalledTimes`
36-
* - `toHaveBeenCalledWith`
37-
* - `toHaveBeenLastCalledWith`
38-
* - `toHaveBeenNthCalledWith`
39-
* - `toHaveReturned`
40-
* - `toHaveReturnedTimes`
41-
* - `toHaveReturnedWith`
42-
* - `toHaveLastReturnedWith`
43-
* - `toHaveNthReturnedWith`
34+
* - [`toHaveBeenCalled`](./doc/~/Expected.toHaveBeenCalled)
35+
* - [`toHaveBeenCalledTimes`](./doc/~/Expected.toHaveBeenCalledTimes)
36+
* - [`toHaveBeenCalledWith`](./doc/~/Expected.toHaveBeenCalledWith)
37+
* - [`toHaveBeenLastCalledWith`](./doc/~/Expected.toHaveBeenLastCalledWith)
38+
* - [`toHaveBeenNthCalledWith`](./doc/~/Expected.toHaveBeenNthCalledWith)
39+
* - [`toHaveReturned`](./doc/~/Expected.toHaveReturned)
40+
* - [`toHaveReturnedTimes`](./doc/~/Expected.toHaveReturnedTimes)
41+
* - [`toHaveReturnedWith`](./doc/~/Expected.toHaveReturnedWith)
42+
* - [`toHaveLastReturnedWith`](./doc/~/Expected.toHaveLastReturnedWith)
43+
* - [`toHaveNthReturnedWith`](./doc/~/Expected.toHaveNthReturnedWith)
4444
* - Asymmetric matchers:
45-
* - `expect.anything`
46-
* - `expect.any`
47-
* - `expect.arrayContaining`
45+
* - [`expect.anything`](./doc/~/expect.anything)
46+
* - [`expect.any`](./doc/~/expect.any)
47+
* - [`expect.arrayContaining`](./doc/~/expect.arrayContaining)
4848
* - `expect.not.arrayContaining`
49-
* - `expect.closeTo`
50-
* - `expect.stringContaining`
49+
* - [`expect.closeTo`](./doc/~/expect.closeTo)
50+
* - [`expect.stringContaining`](./doc/~/expect.stringContaining)
5151
* - `expect.not.stringContaining`
52-
* - `expect.stringMatching`
52+
* - [`expect.stringMatching`](./doc/~/expect.stringMatching)
5353
* - `expect.not.stringMatching`
5454
* - Utilities:
55-
* - `expect.addEqualityTester`
56-
* - `expect.extend`
55+
* - [`expect.addEqualityTester`](./doc/~/expect.addEqualityTester)
56+
* - [`expect.extend`](./doc/~/expect.extend)
5757
*
5858
* Only these functions are still not available:
5959
* - Matchers:

0 commit comments

Comments
 (0)