From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Fri, 12 May 2023 13:55:57 +0000 (+0200)
Subject: docs: add comment on utils helpers
X-Git-Tag: v2.5.0~43^2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=3c653a0342204eae4943cfdef432e9b01dafc0d0;hp=b9bb3c850ae5c12edf0b356b10693b9eb226ddf7;p=poolifier.git

docs: add comment on utils helpers

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/src/utils.ts b/src/utils.ts
index 176d2c4f..164a2aca 100644
--- 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 &&