fix: use proper tsdoc for the config type

TeamWertarbyte · Sep 27, 2024 · 12a3074 · 12a3074
1 parent 21a700e
commit 12a3074
Showing 1 changed file with 12 additions and 8 deletions.
diff --git a/lib/changelog.types.ts b/lib/changelog.types.ts
@@ -1,21 +1,25 @@
 /**
  * Configuration to retrieve changelogs from UpdateHive.
- *
- * @param connection
- *    API_KEY:        API_KEY to access UpdateHive public REST API.
- *    url:            Override the default URL to UpdateHive API.
- *
- * @param changelogs
- *    product:        Product ID to retrieve changelogs for.
- *    onlyLast:       Retrieve only the last changelog.
  */
 export type UpdateHiveConfig = {
   connection: {
+    /**
+     * API_KEY to access UpdateHive public REST API.
+     */
     API_KEY: string;
+    /**
+     * Override the default URL to UpdateHive API.
+     */
     url?: string;
   };
   changelogs: {
+    /**
+     * Product ID to retrieve changelogs for.
+     */
     product: string;
+    /**
+     * Retrieve only the last changelog.
+     */
     onlyLast?: boolean;
   };
 };