Logo for jsDocs.io

@jest/core

  • Version 30.4.2
  • Published
  • 146 kB
  • 28 dependencies
  • MIT license

Install

npm i @jest/core
yarn add @jest/core
pnpm add @jest/core

Overview

Delightful JavaScript Testing.

Index

Functions

Classes

Type Aliases

Functions

function createTestScheduler

createTestScheduler: (
    globalConfig: Config.GlobalConfig,
    context: TestSchedulerContext
) => Promise<TestScheduler>;

    function getVersion

    getVersion: () => string;

      function runCLI

      runCLI: (
          argv: Config.Argv,
          projects: Array<string>
      ) => Promise<{ results: AggregatedResult; globalConfig: Config.GlobalConfig }>;

        Classes

        class SearchSource

        class SearchSource {}

          constructor

          constructor(context: TestContext);

            method filterPathsWin32

            filterPathsWin32: (paths: Array<string>) => Array<string>;

              method findMatchingTests

              findMatchingTests: (
                  testPathPatternsExecutor: TestPathPatternsExecutor
              ) => SearchResult;

                method findRelatedSourcesFromTestsInChangedFiles

                findRelatedSourcesFromTestsInChangedFiles: (
                    changedFilesInfo: ChangedFiles
                ) => Promise<Array<string>>;

                  method findRelatedTests

                  findRelatedTests: (
                      allPaths: Set<string>,
                      collectCoverage: boolean
                  ) => Promise<SearchResult>;

                    method findRelatedTestsFromPattern

                    findRelatedTestsFromPattern: (
                        paths: Array<string>,
                        collectCoverage: boolean
                    ) => Promise<SearchResult>;

                      method findTestRelatedToChangedFiles

                      findTestRelatedToChangedFiles: (
                          changedFilesInfo: ChangedFiles,
                          collectCoverage: boolean
                      ) => Promise<SearchResult>;

                        method findTestsByPaths

                        findTestsByPaths: (paths: Array<string>) => SearchResult;

                          method getTestPaths

                          getTestPaths: (
                              globalConfig: Config.GlobalConfig,
                              projectConfig: Config.ProjectConfig,
                              changedFiles?: ChangedFiles,
                              filter?: Filter
                          ) => Promise<SearchResult>;

                            method isTestFilePath

                            isTestFilePath: (path: string) => boolean;

                              class TestScheduler

                              class TestScheduler {}

                                constructor

                                constructor(globalConfig: Config.GlobalConfig, context: any);

                                  method addReporter

                                  addReporter: (reporter: Reporter) => void;

                                    method removeReporter

                                    removeReporter: (reporterConstructor: ReporterConstructor) => void;

                                      method scheduleTests

                                      scheduleTests: (
                                          tests: Array<Test>,
                                          watcher: TestWatcher
                                      ) => Promise<AggregatedResult>;

                                        Type Aliases

                                        type Filter

                                        type Filter = (testPaths: Array<string>) => Promise<{
                                            filtered: Array<string>;
                                        }>;

                                          type ReporterConstructor

                                          type ReporterConstructor = new (
                                              globalConfig: Config.GlobalConfig,
                                              reporterConfig: Record<string, unknown>,
                                              reporterContext: ReporterContext
                                          ) => BaseReporter;

                                            type SearchResult

                                            type SearchResult = {
                                                noSCM?: boolean;
                                                stats?: Stats;
                                                collectCoverageFrom?: Set<string>;
                                                tests: Array<Test>;
                                                total?: number;
                                            };

                                              type Stats

                                              type Stats = {
                                                  roots: number;
                                                  testMatch: number;
                                                  testPathIgnorePatterns: number;
                                                  testRegex: number;
                                                  testPathPatterns?: number;
                                              };

                                                type TestSchedulerContext

                                                type TestSchedulerContext = ReporterContext & TestRunnerContext;

                                                  Package Files (1)

                                                  Dependencies (28)

                                                  Dev Dependencies (3)

                                                  Peer Dependencies (1)

                                                  Badge

                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@jest/core.

                                                  • Markdown
                                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@jest/core)
                                                  • HTML
                                                    <a href="https://www.jsdocs.io/package/@jest/core"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>