From 29bd5d3445cc1a850f837b852c507816e18f8da4 Mon Sep 17 00:00:00 2001
From: Dmitry Kisler <admin@dkisler.com>
Date: Thu, 12 Oct 2023 17:53:12 +0200
Subject: [PATCH] chore: improves jsdoc.

Signed-off-by: Dmitry Kisler <admin@dkisler.com>
---
 dist/index.js   | 2 ++
 lib/releases.js | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/dist/index.js b/dist/index.js
index 74b04ae..651b12e 100644
--- a/dist/index.js
+++ b/dist/index.js
@@ -31,6 +31,7 @@ class Release {
 /**
  * Fetches the top 30 releases sorted in desc order.
  *
+ * @return {Array<Release>} Releases.
  */
 async function fetchReleases () {
   const url = 'https://api.github.com/repos/opentofu/opentofu/releases';
@@ -66,6 +67,7 @@ async function findLatestVersionInRange (versions, range) {
  *
  * @param {string} version: Release version.
  * @param {function} fetchReleasesFn: Optional function to fetch releases.
+ * @return {Release} Release.
  */
 async function getRelease (version, fetchReleasesFn = fetchReleases) {
   const latestVersionLabel = 'latest';
diff --git a/lib/releases.js b/lib/releases.js
index 3d6376d..295d09e 100644
--- a/lib/releases.js
+++ b/lib/releases.js
@@ -25,6 +25,7 @@ class Release {
 /**
  * Fetches the top 30 releases sorted in desc order.
  *
+ * @return {Array<Release>} Releases.
  */
 async function fetchReleases () {
   const url = 'https://api.github.com/repos/opentofu/opentofu/releases';
@@ -60,6 +61,7 @@ async function findLatestVersionInRange (versions, range) {
  *
  * @param {string} version: Release version.
  * @param {function} fetchReleasesFn: Optional function to fetch releases.
+ * @return {Release} Release.
  */
 async function getRelease (version, fetchReleasesFn = fetchReleases) {
   const latestVersionLabel = 'latest';