feat(rails-status): add JSDoc

primer · Nov 25, 2023 · 504d03e · 504d03e
1 parent 76b278d
commit 504d03e
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/src/rails-status.js b/src/rails-status.js
@@ -1,10 +1,10 @@
-const statusOrder = [
+const statusOrder = /** @type {const} */ ([
   'deprecated',
   'experimental',
   'alpha',
   'beta',
   'stable'
-]
+]);
 
 export const latestStatusFrom = (statuses) => {
   let highestRank = -1
@@ -22,6 +22,11 @@ export const latestStatusFrom = (statuses) => {
   return latestStatus
 }
 
+/**
+ * @param {string} first
+ * @param {string} second
+ * @returns {1 | 0 | -1} sorting order @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description
+ */
 export const compareStatuses = (first, second) => {
   const firstRank = statusOrder.indexOf(first)
   const secondRank = statusOrder.indexOf(second)