npmpackage.info

Gathering detailed insights and metrics for @wistudent/jest-each-improved-types

@wistudent/jest-each-improved-types

Using recursive conditional types from typescript 4.1 to improve typings of table driven jest-each tests

2.1.0

TypeScript

159.00 B

82,596 2.9

Installations

npm install @wistudent/jest-each-improved-types

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Node Version

18.14.1

NPM Version

9.3.1 Score

50.5

Supply Chain

62.8

Quality

72.1

Maintenance

100

Vulnerability

97.9

License

Pull Requests

Open

1

Total

279

Closed

33

Merged

245

Issues

Open

0

Total

0

Closed

0

Releases

v2.1.0

Published on 25 Feb 2023

View all 1 releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

TypeScript

JavaScript

TypeScript (99.03%)

JavaScript (0.97%)

Developer

WIStudent

Download Statistics

Total Downloads

82,596

Last Day

Last Week

277

Last Month

1,391

Last Year

39,905

GitHub Statistics

2 Stars

537 Commits

2 Watching

2 Branches

1 Contributors

Bundle Size

208.00 B

Minified

159.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.1.0

Package Id

@wistudent/jest-each-improved-types@2.1.0

Unpacked Size

5.12 kB

Size

1.92 kB

File Count

NPM Version

9.3.1

Node Version

18.14.1

Publised On

25 Feb 2023

Total Downloads

Cumulative downloads

Total Downloads

82,596

Last day

15.6%

Compared to previous day

Last week

-29.7%

277

Compared to previous week

Last month

-12.8%

1,391

Compared to previous month

Last year

63.9%

39,905

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

@jest/globals @jest/types typescript

Dev Dependencies

@jest/globals @jest/types @tsd/typescript jest jest-runner-tsd

Versions

jest-each-improved-types

When using .each with the table notation, it is possible to set the type of the test function argument on the .each function as a generic argument:

1import {test, expect} from "@jest/globals";
2
3test.each<{a: string, b: number, expected: boolean}>`
4a      | b    | expected
5${'1'} | ${1} | ${true}
6${'1'} | ${2} | ${false}
7`('some test', ({a, b, expected}) => {
8  expect(a === `${b}`).toBe(expected)
9});

But this only sets the type for the test function argument, it does not ensure that the correct values were used inside the table. The following does not result in a typescript error:

1import {test, expect} from "@jest/globals";
2
3test.each<{a: string, b: number, expected: boolean}>`
4a            | b     | expected
5${undefined} | ${{}} | ${null}
6`('some test', ({a, b, expected}) => {
7  expect(a === `${b}`).toBe(expected)
8});

This package adds an additional way of providing type definitons to .each table tests that ensures that the values used inside the table are compatible with the provided typescript types. It does by reexporting @jest/globals and extending the type definition of the .each function.

1import {test, expect} from "@wistudent/jest-each-improved-types"
2
3test.each<[['a', string], ['b', number], ['expected', boolean]], 2>`
4a      | b    | expected
5${'1'} | ${1} | ${true}
6${'1'} | ${2} | ${false}
7`('some test', ({a, b, expected}) => {
8  expect(a === `${b}`).toBe(expected)
9});

Instead of using an interface as the generic argument, a tuple of Key-Type pairs and the number of rows is used. Using a value with the wrong type inside the table, or the number of values not being (Number of Key-Type pairs * Declared number of rows), will result in a typescript error.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

2.9

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More