docs: add comment on utils helpers

[poolifier.git] / src / utils.ts

diff --git a/src/utils.ts b/src/utils.ts
index 403fed951bb21f7af0474b65cc8a02fbec6d5a78..164a2aca5eeeec3ae86b9bfcdeeb72d872c32cb7 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -28,10 +28,20 @@ export const median = (dataSet: number[]): number => {
   if (Array.isArray(dataSet) && dataSet.length === 1) {
     return dataSet[0]
   }
-  dataSet = dataSet.slice().sort((a, b) => a - b)
-  return (dataSet[(dataSet.length - 1) >> 1] + dataSet[dataSet.length >> 1]) / 2
+  const sortedDataSet = dataSet.slice().sort((a, b) => a - b)
+  return (
+    (sortedDataSet[(sortedDataSet.length - 1) >> 1] +
+      sortedDataSet[sortedDataSet.length >> 1]) /
+    2
+  )
 }
 
+/**
+ * Is the given object a plain object?
+ *
+ * @param obj - The object to check.
+ * @returns `true` if the given object is a plain object, `false` otherwise.
+ */
 export const isPlainObject = (obj: unknown): boolean =>
   typeof obj === 'object' &&
   obj !== null &&