deprecation(semver): deprecate rangeMax() and rangeMin() (#4561)

Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
denoland · Apr 11, 2024 · 6220121 · 6220121
1 parent b5af8da
commit 6220121
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/semver/range_max.ts b/semver/range_max.ts
@@ -44,6 +44,12 @@ function comparatorMax(comparator: Comparator): SemVer {
 }
 
 /**
+ * @deprecated (will be removed in 1.0.0) Use {@linkcode greaterThanRange} or
+ * {@linkcode lessThanRange} for comparing ranges and semvers. The maximum
+ * version of a range is often not well defined, and therefore this API
+ * shouldn't be used. See
+ * {@link https://github.com/denoland/deno_std/issues/4365} for details.
+ *
  * The maximum valid SemVer for a given range or INVALID
  * @param range The range to calculate the max for
  * @returns A valid SemVer or INVALID

diff --git a/semver/range_min.ts b/semver/range_min.ts
@@ -35,6 +35,12 @@ function comparatorMin(comparator: Comparator): SemVer {
 }
 
 /**
+ * @deprecated (will be removed in 1.0.0) Use {@linkcode greaterThanRange} or
+ * {@linkcode lessThanRange} for comparing ranges and semvers. The minimum
+ * version of a range is often not well defined, and therefore this API
+ * shouldn't be used. See
+ * {@link https://github.com/denoland/deno_std/issues/4365} for details.
+ *
  * The minimum valid SemVer for a given range or INVALID
  * @param range The range to calculate the min for
  * @returns A valid SemVer or INVALID