🎨 Palette: Improve JSDoc for comparisons and EOL dates

.changeset/calm-pandas-sing.md

@@ -0,0 +1,5 @@
+---
+"node-version": patch
+---
+
+Improve JSDoc for version comparison methods and EOL dates.

.jules/palette.md

@@ -0,0 +1,5 @@
+# Palette's Journal
+
+## 2026-01-03 - Documenting Fail-Closed Behavior
+**Learning:** For utility libraries, explicitly documenting "fail-closed" behavior (returning false/undefined instead of throwing) is a critical DX improvement, as users might assume validation errors throw.
+**Action:** Always check edge case return values and ensure they are documented in JSDoc/TSDoc.

src/index.ts

@@ -11,6 +11,7 @@ export type { NodeVersion };
 
 /**
  * End-of-Life dates for Node.js major versions.
+ * @see https://github.com/nodejs/release#release-schedule
  */
 export const EOL_DATES: Record<string, string> = {
     "18": "2025-04-30",

src/types.ts

@@ -35,7 +35,7 @@ export interface NodeVersion {
     /**
      * Check if the current Node version is at least the specified version.
      * @param version The version to compare against (e.g., '20.0.0').
-     * @returns {boolean} True if current version >= target version.
+     * @returns {boolean} True if current version >= target version. Returns false for invalid version strings.
      * @example
      * version.isAtLeast('18.0.0'); // true if current is 20.0.0
      */
@@ -51,23 +51,23 @@ export interface NodeVersion {
     /**
      * Check if the current Node version is strictly greater than the specified version.
      * @param version The version to compare against (e.g., '20.0.0').
-     * @returns {boolean} True if current version > target version.
+     * @returns {boolean} True if current version > target version. Returns false for invalid version strings.
      * @example
      * version.isAbove('18.0.0'); // true if current is 20.0.0
      */
     isAbove(version: string): boolean;
     /**
      * Check if the current Node version is strictly less than the specified version.
      * @param version The version to compare against (e.g., '20.0.0').
-     * @returns {boolean} True if current version < target version.
+     * @returns {boolean} True if current version < target version. Returns false for invalid version strings.
      * @example
      * version.isBelow('22.0.0'); // true if current is 20.0.0
      */
     isBelow(version: string): boolean;
     /**
      * Check if the current Node version is at most the specified version.
      * @param version The version to compare against (e.g., '20.0.0').
-     * @returns {boolean} True if current version <= target version.
+     * @returns {boolean} True if current version <= target version. Returns false for invalid version strings.
      * @example
      * version.isAtMost('22.0.0'); // true if current is 20.0.0
      */