fix: improve types (#423)

Author: Uzlopak

src/bench.ts

@@ -7,6 +7,7 @@ import type {
   EventListenerObject,
   Fn,
   FnOptions,
+  JSRuntime,
   RemoveEventListenerOptionsArgument,
   TaskResult,
 } from './types'
@@ -23,7 +24,6 @@ import { Task } from './task'
 import {
   defaultConvertTaskResultForConsoleTable,
   invariant,
-  type JSRuntime,
   performanceNow,
   runtime,
   runtimeVersion,

src/index.ts

@@ -10,10 +10,10 @@ export type {
   FnOptions,
   FnReturnedObject,
   Hook,
+  JSRuntime,
   ResolvedBenchOptions,
   Statistics,
   TaskEvents,
   TaskResult,
 } from './types'
-export type { JSRuntime } from './utils'
 export { hrtimeNow, performanceNow as now, nToMs } from './utils'

src/types.ts

@@ -1,6 +1,5 @@
 import type { BenchEvent } from '../src/event'
 import type { Task } from '../src/task'
-import type { JSRuntime } from './utils'
 export type { BenchEvent } from '../src/event'
 
 export type AddEventListenerOptionsArgument = Parameters<
@@ -22,9 +21,9 @@ export type BenchEvents =
   | 'warmup' // when the benchmarks start getting warmed up
 
 export type BenchEventsOptionalTask = Omit<BenchEvents, 'add' | 'cycle' | 'error' | 'remove'>
+
 export type BenchEventsWithError = Extract<BenchEvents, 'error'>
 export type BenchEventsWithTask = Extract<BenchEvents, 'add' | 'cycle' | 'error' | 'remove'>
-
 export interface BenchLike extends EventTarget {
   addEventListener: <K extends BenchEvents>(
     type: K,
@@ -144,16 +143,16 @@ export type ConsoleTableConverter = (
  */
 export type EventListener<E extends BenchEvents, M extends 'bench' | 'task' = 'bench'> = (evt: BenchEvent<E, M>) => void
 
+export interface EventListenerObject<E extends BenchEvents, M extends 'bench' | 'task' = 'bench'> {
+  handleEvent(evt: BenchEvent<E, M>): void
+}
+
 /**
  * Both the `Task` and `Bench` objects extend the `EventTarget` object.
  * So you can attach a listeners to different types of events to each class instance
  * using the universal `addEventListener` and `removeEventListener` methods.
  */
 
-export interface EventListenerObject<E extends BenchEvents, M extends 'bench' | 'task' = 'bench'> {
-  handleEvent(evt: BenchEvent<E, M>): void
-}
-
 /**
  * The task function.
  *
@@ -243,6 +242,28 @@ export type Hook = (
   mode?: 'run' | 'warmup'
 ) => Promise<void> | void
 
+/**
+ * The JavaScript runtime environment.
+ * @see https://runtime-keys.proposal.wintercg.org/
+ */
+export type JSRuntime =
+  | 'browser'
+  | 'bun'
+  | 'deno'
+  | 'edge-light'
+  | 'fastly'
+  | 'hermes'
+  | 'jsc'
+  | 'lagon'
+  | 'moddable'
+  | 'netlify'
+  | 'node'
+  | 'quickjs-ng'
+  | 'spidermonkey'
+  | 'unknown'
+  | 'v8'
+  | 'workerd'
+
 // @types/node doesn't have these types globally, and we don't want to bring "dom" lib for everyone
 export type RemoveEventListenerOptionsArgument = Parameters<
   typeof EventTarget.prototype.removeEventListener

src/utils.ts

@@ -5,33 +5,12 @@ import type { Task } from './task'
 import type {
   ConsoleTableConverter,
   Fn,
+  JSRuntime,
   Statistics,
 } from './types'
 
 import { emptyFunction, tTable } from './constants'
 
-/**
- * The JavaScript runtime environment.
- * @see https://runtime-keys.proposal.wintercg.org/
- */
-export type JSRuntime =
-  | 'browser'
-  | 'bun'
-  | 'deno'
-  | 'edge-light'
-  | 'fastly'
-  | 'hermes'
-  | 'jsc'
-  | 'lagon'
-  | 'moddable'
-  | 'netlify'
-  | 'node'
-  | 'quickjs-ng'
-  | 'spidermonkey'
-  | 'unknown'
-  | 'v8'
-  | 'workerd'
-
 /**
  * @param g GlobalThis object
  * @returns Detected runtime and its version
@@ -310,15 +289,13 @@ export const meanAndVariance = (samples: Samples): { mean: number; vr: number }
   }
 }
 
-type Quantile = 0.5 | 0.75 | 0.99 | 0.995 | 0.999
-
 /**
  * Computes the q-quantile of a sorted sample.
  * @param samples - the sorted sample
  * @param q - the quantile to compute
  * @returns the q-quantile of the sample
  */
-const quantileSorted = (samples: SortedSamples, q: Quantile): number => {
+const quantileSorted = (samples: SortedSamples, q: 0.5 | 0.75 | 0.99 | 0.995 | 0.999): number => {
   const base = (samples.length - 1) * q
   const baseIndex = Math.floor(base)