improve jsdoc [skip ci]

tbouffard · tbouffard · commit 6e8099512095 · 2025-08-27T14:56:18.000+02:00
diff --git a/packages/core/src/internal/utils.ts b/packages/core/src/internal/utils.ts
@@ -34,11 +34,10 @@ export const isElement = (node?: Node | UserObject | null): node is Element =>
   node?.nodeType === NODE_TYPE.ELEMENT;
 
 /**
- * Use this function to check for null or undefined values for objects having falsy values in addition to nullish values:
+ * Returns true if the input is null or undefined.
  *
- * - boolean (false)
- * - number (0)
- * - string (empty)
+ * **Note**: falsy-but-defined values (false, 0, '') are NOT considered nullish.
+ * Use this when you must allow falsy values but reject absent ones, generally when the parameter is boolean, number or string.
  *
  * @private not part of the public API, can be removed or changed without prior notice
  */

Original file line number	Diff line number	Diff line change
`@@ -34,11 +34,10 @@ export const isElement = (node?: Node \| UserObject \| null): node is Element =>`
`34`	`34`	`node?.nodeType === NODE_TYPE.ELEMENT;`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * Use this function to check for null or undefined values for objects having falsy values in addition to nullish values:`
	`37`	`+ * Returns true if the input is null or undefined.`
`38`	`38`	`*`
`39`		`- * - boolean (false)`
`40`		`- * - number (0)`
`41`		`- * - string (empty)`
	`39`	`+ * Note: falsy-but-defined values (false, 0, '') are NOT considered nullish.`
	`40`	`+ * Use this when you must allow falsy values but reject absent ones, generally when the parameter is boolean, number or string.`
`42`	`41`	`*`
`43`	`42`	`* @private not part of the public API, can be removed or changed without prior notice`
`44`	`43`	`*/`