Skip to content

Improve each template literal infer #14920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SimenB merged 6 commits into from
Mar 17, 2024
Merged

Improve each template literal infer #14920

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9969aed
feat: improve type inference for template literals .each syntax
MathieuFedrigo Feb 23, 2024
f4f8533
docs: clarify type checking for template literals .each syntax
MathieuFedrigo Feb 23, 2024
bdf450c
add changelog entry
MathieuFedrigo Feb 23, 2024
b4af639
Merge branch 'main' into improve-each-template-literal-infer
SimenB Mar 17, 2024
fcc5d18
Update CHANGELOG.md
SimenB Mar 17, 2024
acf875e
Update docs/GlobalAPI.md
SimenB Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: clarify type checking for template literals .each syntax
  • Loading branch information
@MathieuFedrigo
MathieuFedrigo committed Feb 26, 2024
commit f4f8533c58fff281f4671acb3d537dba85f278db
20 changes: 20 additions & 0 deletions docs/GlobalAPI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,3 +1094,23 @@ test.each<{a: number; b: number; expected: string; extra?: boolean}>`
// all arguments are typed as expected, e.g. `a: number`, `expected: string`, `extra: boolean | undefined`
});
```

:::caution

Keep in mind the variables inside the template literal are not type checked, so you have to ensure that their types are correct.

```ts
import {test} from '@jest/globals';

test.each<{a: number; expected: string}>`
a | expected
${1} | ${'one'}
${'will not raise TS error'} | ${'two'}
${3} | ${'three'}
`('template literal with wrongly typed input', ({a, expected}) => {
// all arguments are typed as stated in the generic: `a: number`, `expected: string`
// WARNING: `a` is of type `number` but will be a string in the 2nd test case.
});
```

:::