Merge branch 'master' into chore/use-biome
[poolifier.git] / src / utils.ts
index 21b2032b47086484e2b39475b06310950d95c08b..400a92b14a7f42e8518878af1744623c8f6c2290 100644 (file)
@@ -52,29 +52,59 @@ export const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsR
  * Always returns a value greater than zero.
  *
  * @returns The host OS optimized maximum pool size.
- * @internal
  */
 export const availableParallelism = (): number => {
   let availableParallelism = 1
   try {
     availableParallelism = os.availableParallelism()
   } catch {
-    const numberOfCpus = os.cpus()
-    if (Array.isArray(numberOfCpus) && numberOfCpus.length > 0) {
-      availableParallelism = numberOfCpus.length
+    const cpus = os.cpus()
+    if (Array.isArray(cpus) && cpus.length > 0) {
+      availableParallelism = cpus.length
     }
   }
   return availableParallelism
 }
 
+/**
+ * Returns the worker type of the given worker.
+ *
+ * @param worker - The worker to get the type of.
+ * @returns The worker type of the given worker.
+ * @internal
+ */
+export const getWorkerType = (worker: IWorker): WorkerType | undefined => {
+  if (worker instanceof ThreadWorker) {
+    return WorkerTypes.thread
+  } else if (worker instanceof ClusterWorker) {
+    return WorkerTypes.cluster
+  }
+}
+
+/**
+ * Returns the worker id of the given worker.
+ *
+ * @param worker - The worker to get the id of.
+ * @returns The worker id of the given worker.
+ * @internal
+ */
+export const getWorkerId = (worker: IWorker): number | undefined => {
+  if (worker instanceof ThreadWorker) {
+    return worker.threadId
+  } else if (worker instanceof ClusterWorker) {
+    return worker.id
+  }
+}
+
 /**
  * Sleeps for the given amount of milliseconds.
  *
  * @param ms - The amount of milliseconds to sleep.
  * @returns A promise that resolves after the given amount of milliseconds.
+ * @internal
  */
 export const sleep = async (ms: number): Promise<void> => {
-  await new Promise((resolve) => {
+  await new Promise(resolve => {
     setTimeout(resolve, ms)
   })
 }
@@ -116,41 +146,6 @@ export const average = (dataSet: number[]): number => {
   )
 }
 
-/**
- * Returns the worker type of the given worker.
- *
- * @param worker - The worker to get the type of.
- * @returns The worker type of the given worker.
- * @internal
- */
-export const getWorkerType = <Worker extends IWorker>(
-  worker: Worker
-): WorkerType | undefined => {
-  if (worker instanceof ThreadWorker) {
-    return WorkerTypes.thread
-  }
-  if (worker instanceof ClusterWorker) {
-    return WorkerTypes.cluster
-  }
-}
-
-/**
- * Returns the worker id of the given worker.
- *
- * @param worker - The worker to get the id of.
- * @returns The worker id of the given worker.
- * @internal
- */
-export const getWorkerId = <Worker extends IWorker>(
-  worker: Worker
-): number | undefined => {
-  if (worker instanceof ThreadWorker) {
-    return worker.threadId
-  } else if (worker instanceof ClusterWorker) {
-    return worker.id
-  }
-}
-
 /**
  * Computes the median of the given data set.
  *
@@ -180,6 +175,7 @@ export const median = (dataSet: number[]): number => {
  * @param num - The number to round.
  * @param scale - The scale to round to.
  * @returns The rounded number.
+ * @internal
  */
 export const round = (num: number, scale = 2): number => {
   const rounder = Math.pow(10, scale)
@@ -191,6 +187,7 @@ export const round = (num: number, scale = 2): number => {
  *
  * @param obj - The object to check.
  * @returns `true` if the given object is a plain object, `false` otherwise.
+ * @internal
  */
 export const isPlainObject = (obj: unknown): boolean =>
   typeof obj === 'object' &&
@@ -219,6 +216,7 @@ export const isKillBehavior = <KB extends KillBehavior>(
  *
  * @param fn - Any value.
  * @returns `true` if `fn` was an asynchronous function, otherwise `false`.
+ * @internal
  */
 export const isAsyncFunction = (
   fn: unknown
@@ -243,11 +241,11 @@ export const updateMeasurementStatistics = (
   if (measurementRequirements.aggregate) {
     measurementStatistics.aggregate =
       (measurementStatistics.aggregate ?? 0) + measurementValue
-    measurementStatistics.minimum = Math.min(
+    measurementStatistics.minimum = min(
       measurementValue,
       measurementStatistics.minimum ?? Infinity
     )
-    measurementStatistics.maximum = Math.max(
+    measurementStatistics.maximum = max(
       measurementValue,
       measurementStatistics.maximum ?? -Infinity
     )
@@ -258,43 +256,46 @@ export const updateMeasurementStatistics = (
       measurementStatistics.history.push(measurementValue)
       if (measurementRequirements.average) {
         measurementStatistics.average = average(measurementStatistics.history)
+      } else if (measurementStatistics.average != null) {
+        delete measurementStatistics.average
       }
       if (measurementRequirements.median) {
         measurementStatistics.median = median(measurementStatistics.history)
+      } else if (measurementStatistics.median != null) {
+        delete measurementStatistics.median
       }
     }
   }
 }
 
 /**
- * Executes a function once at a time.
+ * Generates a cryptographically secure random number in the [0,1[ range
  *
- * @param fn - The function to execute.
- * @param context - The context to bind the function to.
- * @returns The function to execute.
+ * @returns A number in the [0,1[ range
+ * @internal
  */
-export const once = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  fn: (...args: any[]) => void,
-  context: unknown
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-): ((...args: any[]) => void) => {
-  let called = false
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  return function (...args: any[]): void {
-    if (!called) {
-      called = true
-      fn.apply(context, args)
-      called = false
-    }
-  }
+export const secureRandom = (): number => {
+  return webcrypto.getRandomValues(new Uint32Array(1))[0] / 0x100000000
 }
 
 /**
- * Generate a cryptographically secure random number in the [0,1[ range
+ * Returns the minimum of the given numbers.
+ * If no numbers are given, `Infinity` is returned.
  *
- * @returns A number in the [0,1[ range
+ * @param args - The numbers to get the minimum of.
+ * @returns The minimum of the given numbers.
+ * @internal
  */
-export const secureRandom = (): number => {
-  return webcrypto.getRandomValues(new Uint32Array(1))[0] / 0x100000000
-}
+export const min = (...args: number[]): number =>
+  args.reduce((minimum, num) => (minimum < num ? minimum : num), Infinity)
+
+/**
+ * Returns the maximum of the given numbers.
+ * If no numbers are given, `-Infinity` is returned.
+ *
+ * @param args - The numbers to get the maximum of.
+ * @returns The maximum of the given numbers.
+ * @internal
+ */
+export const max = (...args: number[]): number =>
+  args.reduce((maximum, num) => (maximum > num ? maximum : num), -Infinity)