Rename result -> results to align with runCLI api

jestjs · Apr 22, 2023 · 1935947 · 1935947
1 parent 0f8f6f2
commit 1935947
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/e2e/run-programmatically/core.mjs b/e2e/run-programmatically/core.mjs
@@ -12,5 +12,5 @@ const runConfig = Object.freeze({
   collectCoverage: false,
   watch: false,
 });
-const {result} = await jest.runCore(runConfig, configs);
-console.log(`runCore success, ${result.numPassedTests} passed tests.`);
+const {results} = await jest.runCore(runConfig, configs);
+console.log(`runCore success, ${results.numPassedTests} passed tests.`);
diff --git a/packages/jest-core/src/__tests__/runCore.test.ts b/packages/jest-core/src/__tests__/runCore.test.ts
@@ -42,7 +42,7 @@ describe(runCore, () => {
       makeProjectConfig(),
     ]);
     expect(jest.mocked(runJest)).toHaveBeenCalled();
-    expect(actualResult).toEqual({result: {results: {success: true}}});
+    expect(actualResult).toEqual({results: {results: {success: true}}});
   });
 
   it('should provide stderr as output stream when useStderr is true', async () => {

diff --git a/packages/jest-core/src/runCore.ts b/packages/jest-core/src/runCore.ts
@@ -35,16 +35,16 @@ const {print: preRunMessagePrint} = preRunMessage;
  * import {runCore, readConfigs} from 'jest';
  *
  * const {globalConfig, configs} = await readConfigs(process.argv, [process.cwd()]);
- * const results = await runCore(globalConfig, configs);
+ * const {results} = await runCore(globalConfig, configs);
  * console.log(results);
  */
 export async function runCore(
   globalConfig: Config.GlobalConfig,
   projectConfigs: Array<Config.ProjectConfig>,
 ): Promise<RunCoreResult> {
   const outputStream = globalConfig.useStderr ? process.stderr : process.stdout;
-  const result = await _run(globalConfig, projectConfigs, false, outputStream);
-  return {result};
+  const results = await _run(globalConfig, projectConfigs, false, outputStream);
+  return {results};
 }
 
 const buildContextsAndHasteMaps = async (

diff --git a/packages/jest-core/src/types.ts b/packages/jest-core/src/types.ts
@@ -51,5 +51,5 @@ export type OnCompleteCallback = (
  * The result of running runCore.
  */
 export type RunCoreResult = {
-  result: AggregatedResult;
+  results: AggregatedResult;
 };