Skip to content

Commit 12a3074

Browse files
leMaiksaschb2b
authored andcommitted
fix: use proper tsdoc for the config type
1 parent 21a700e commit 12a3074

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

lib/changelog.types.ts

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
11
/**
22
* Configuration to retrieve changelogs from UpdateHive.
3-
*
4-
* @param connection
5-
* API_KEY: API_KEY to access UpdateHive public REST API.
6-
* url: Override the default URL to UpdateHive API.
7-
*
8-
* @param changelogs
9-
* product: Product ID to retrieve changelogs for.
10-
* onlyLast: Retrieve only the last changelog.
113
*/
124
export type UpdateHiveConfig = {
135
connection: {
6+
/**
7+
* API_KEY to access UpdateHive public REST API.
8+
*/
149
API_KEY: string;
10+
/**
11+
* Override the default URL to UpdateHive API.
12+
*/
1513
url?: string;
1614
};
1715
changelogs: {
16+
/**
17+
* Product ID to retrieve changelogs for.
18+
*/
1819
product: string;
20+
/**
21+
* Retrieve only the last changelog.
22+
*/
1923
onlyLast?: boolean;
2024
};
2125
};

0 commit comments

Comments
 (0)