@jest/types
Advanced tools
Package description
The @jest/types package provides TypeScript definitions and utility types for Jest, a popular JavaScript testing framework. It includes types for Jest configuration, global variables, and other utilities that help in creating type-safe test environments and extending Jest functionalities.
Config
Defines types for Jest configuration options. This allows for type-safe Jest configuration files, ensuring that any configuration options passed to Jest are valid.
{"globals": {"myGlobal": "value"}, "testMatch": ["**/__tests__/**/*.js?(x)", "**/?(*.)+(spec|test).js?(x)"]}Global
Provides types for Jest's global variables and functions, such as 'describe', 'it', and 'expect'. This is useful for creating custom global setups or mocks in a type-safe manner.
"declare var jest: jest.Jest"Mock
Includes types for Jest's mocking utilities, enabling developers to create and manipulate mocks with full TypeScript support.
"const mockedFunction: jest.Mock = jest.fn()"Before Jest provided its own TypeScript definitions, @types/jest was the go-to package for Jest types. It serves a similar purpose by providing type definitions for Jest, but @jest/types is more up-to-date and maintained by the Jest team.
While ts-jest is primarily a TypeScript preprocessor for Jest, allowing Jest to understand TypeScript files, it also includes some utility types for configuration. However, @jest/types focuses solely on providing comprehensive type definitions for Jest's API.
jest-mock-extended provides extended types and utilities for mocking in Jest, particularly with TypeScript. It complements @jest/types by offering more detailed mock creation and manipulation capabilities, though @jest/types provides the foundational type definitions.
Changelog
28.1.3
[jest-leak-detector] Use native FinalizationRegistry when it exists to get rid of external C dependency (#12973)[jest-changed-files] Fix a lock-up after repeated invocations (#12757)[@jest/expect-utils] Fix deep equality of ImmutableJS OrderedSets (#12977)[jest-mock] Add index signature support for spyOn types (#13013, #13020)[jest-snapshot] Fix indentation of awaited inline snapshots (#12986)Readme
This package contains shared types of Jest's packages.
If you are looking for types of Jest globals, you can import them from @jest/globals package:
import {describe, expect, it} from '@jest/globals';
describe('my tests', () => {
it('works', () => {
expect(1).toBe(1);
});
});
If you prefer to omit imports, a similar result can be achieved installing the @types/jest package. Note that this is a third party library maintained at DefinitelyTyped and may not cover the latest Jest features.
Another use-case for @types/jest is a typed Jest config as those types are not provided by Jest out of the box:
// jest.config.ts
import {Config} from '@jest/types';
const config: Config.InitialOptions = {
// some typed config
};
export default config;
FAQs
This package contains shared types of Jest's packages.
The npm package @jest/types receives a total of 56,732,200 weekly downloads. As such, @jest/types popularity was classified as popular.
We found that @jest/types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.