refactor: cleanup exports

[poolifier.git] / src / utils.ts

diff --git a/src/utils.ts b/src/utils.ts
index a6f5fbcc5b729b98f5dec1da1de8178eff830d40..1b657bce22acaf49a39552f411f1bc4899834777 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -3,6 +3,7 @@ import type {
   MeasurementStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './pools/selection-strategies/selection-strategies-types'
+import type { KillBehavior } from './worker/worker-options'
 
 /**
  * An intentional empty function.
@@ -32,7 +33,10 @@ export const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsR
   }
 
 /**
- * Safe helper to get the host OS optimized maximum pool size.
+ * Returns safe host OS optimized estimate of the default amount of parallelism a pool should use.
+ * Always returns a value greater than zero.
+ *
+ * @returns The host OS optimized maximum pool size.
  */
 export const availableParallelism = (): number => {
   let availableParallelism = 1
@@ -48,7 +52,7 @@ export const availableParallelism = (): number => {
 }
 
 /**
- * Compute the median of the given data set.
+ * Computes the median of the given data set.
  *
  * @param dataSet - Data set.
  * @returns The median of the given data set.
@@ -68,6 +72,19 @@ export const median = (dataSet: number[]): number => {
   )
 }
 
+/**
+ * Rounds the given number to the given scale.
+ * The rounding is done using the "round half away from zero" method.
+ *
+ * @param num - The number to round.
+ * @param scale - The scale to round to.
+ * @returns The rounded number.
+ */
+export const round = (num: number, scale = 2): number => {
+  const rounder = Math.pow(10, scale)
+  return Math.round(num * rounder * (1 + Number.EPSILON)) / rounder
+}
+
 /**
  * Is the given object a plain object?
  *
@@ -79,3 +96,18 @@ export const isPlainObject = (obj: unknown): boolean =>
   obj !== null &&
   obj?.constructor === Object &&
   Object.prototype.toString.call(obj) === '[object Object]'
+
+/**
+ * Detects whether the given value is a kill behavior or not.
+ *
+ * @typeParam KB - Which specific KillBehavior type to test against.
+ * @param killBehavior - Which kind of kill behavior to detect.
+ * @param value - Any value.
+ * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
+ */
+export const isKillBehavior = <KB extends KillBehavior>(
+  killBehavior: KB,
+  value: unknown
+): value is KB => {
+  return value === killBehavior
+}