types(vest): add suiteName type to SuiteResult

ealush · Jul 16, 2022 · 9b46fb6 · 9b46fb6 · vercel · Jul 16, 2022
1 parent 47d688a
commit 9b46fb6
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/packages/vest/src/core/suite/create.ts b/packages/vest/src/core/suite/create.ts
@@ -32,13 +32,13 @@ export type Suite<T extends CB> = {
  *  });
  * });
  */
-function create<T extends CB>(suiteName: string, suiteCallback: T): Suite<T>;
+function create<T extends CB>(suiteName: SuiteName, suiteCallback: T): Suite<T>;
 function create<T extends CB>(suiteCallback: T): Suite<T>;
 // eslint-disable-next-line max-lines-per-function
 function create<T extends CB>(
-  ...args: [suiteName: string, suiteCallback: T] | [suiteCallback: T]
+  ...args: [suiteName: SuiteName, suiteCallback: T] | [suiteCallback: T]
 ): Suite<T> {
-  const [suiteCallback, suiteName] = args.reverse() as [T, string];
+  const [suiteCallback, suiteName] = args.reverse() as [T, SuiteName];
 
   invariant(
     isFunction(suiteCallback),
@@ -101,3 +101,5 @@ function create<T extends CB>(
 }
 
 export default create;
+
+export type SuiteName = string | void;
diff --git a/packages/vest/src/core/suite/produce/produceSuiteResult.ts b/packages/vest/src/core/suite/produce/produceSuiteResult.ts
@@ -1,5 +1,7 @@
 import { cache as createCache, assign } from 'vest-utils';
 
+import { SuiteSummary } from 'SuiteSummaryTypes';
+import { SuiteName } from 'create';
 import ctx from 'ctx';
 import genTestsSummary from 'genTestsSummary';
 import { useStateRef, useTestsFlat, useSuiteName } from 'stateHooks';
@@ -24,4 +26,5 @@ export function produceSuiteResult(): SuiteResult {
   );
 }
 
-export type SuiteResult = ReturnType<typeof genTestsSummary> & SuiteSelectors;
+export type SuiteResult = SuiteSummary &
+  SuiteSelectors & { suiteName: SuiteName };