Commitf4f8533

committed

docs: clarify type checking for template literals .each syntax

1 parent9969aed commitf4f8533Copy full SHA for f4f8533

File tree

+20

-0

lines changed

+20

-0

lines changed

Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -1094,3 +1094,23 @@ test.each<{a: number; b: number; expected: string; extra?: boolean}>`
`1094`	`1094`	// all arguments are typed as expected, e.g. `a: number`, `expected: string`, `extra: boolean \| undefined`
`1095`	`1095`	`});`
`1096`	`1096`	```
	`1097`	`+`
	`1098`	`+:::caution`
	`1099`	`+`
	`1100`	`+Keep in mind the variables inside the template literal are not type checked, so you have to ensure that their types are correct.`
	`1101`	`+`
	`1102`	+```ts
	`1103`	`+import {test}from'@jest/globals';`
	`1104`	`+`
	`1105`	+test.each<{a:number; expected:string}>`
	`1106`	`+ a \| expected`
	`1107`	`+ ${1} \| ${'one'}`
	`1108`	`+ ${'will not raise TS error'} \| ${'two'}`
	`1109`	`+ ${3} \| ${'three'}`
	`1110`	+`('template literal with wrongly typed input', ({a,expected})=> {
	`1111`	+// all arguments are typed as stated in the generic: `a: number`, `expected: string`
	`1112`	+// WARNING: `a` is of type `number` but will be a string in the 2nd test case.
	`1113`	`+});`
	`1114`	+```
	`1115`	`+`
	`1116`	`+:::`

Comments

(0)