refactor: move helpers to utils.ts file

[poolifier.git] / src / utils.ts

diff --git a/src/utils.ts b/src/utils.ts
index 7ac4ab25db67446a49b2fc42a0f219c043d4af6f..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.
@@ -95,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
+}