docs: add comment on utils helpers

[poolifier.git] / src / utils.ts

diff --git a/src/utils.ts b/src/utils.ts
index 176d2c4f875fb2b3fc695ad419a8398d12467bb5..164a2aca5eeeec3ae86b9bfcdeeb72d872c32cb7 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -36,6 +36,12 @@ export const median = (dataSet: number[]): number => {
   )
 }
 
+/**
+ * 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 &&