Skip to content

Commit f67750a

Browse files
committed
fix: resolve JSDOC types
Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>
1 parent e30fc2d commit f67750a

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

src/api.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ type ApiGetAppSettings = never
4343
* @param data Parameters for request
4444
* @param config Axios config for setting data
4545
* @return Array of fetched log entries
46-
* @throws AxiosError with HTTP status 424 if log type is not set to `file`
46+
* @throws {AxiosError} with HTTP status 424 if log type is not set to `file`
4747
*/
4848
export const getLog = (data: ApiGetLog, config: AxiosRequestConfig<ApiGetLog> = {}) => axios.get<ApiLogResult, AxiosResponse<ApiLogResult, ApiGetLog>>(generateUrl('apps/logreader/api/log'), { ...config, params: data }) as Promise<AxiosResponse<ApiLogResult>>
4949

@@ -53,7 +53,7 @@ export const getLog = (data: ApiGetLog, config: AxiosRequestConfig<ApiGetLog> =
5353
* @param data Parameters for request
5454
* @param config Axios config for setting data
5555
* @return Array of fetched log entries
56-
* @throws AxiosError with HTTP status 424 if log type is not set to `file`
56+
* @throws {AxiosError} with HTTP status 424 if log type is not set to `file`
5757
*/
5858
export const pollLog = (data: ApiPollLog, config: AxiosRequestConfig<ApiPollLog> = {}) => axios.get<ApiPollLogResult, AxiosResponse<ApiPollLogResult, ApiPollLog>>(generateUrl('apps/logreader/api/poll'), { ...config, params: data }) as Promise<AxiosResponse<ApiPollLogResult>>
5959

src/utils/exception.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ function isOldStyleException(logMessage: unknown) {
7878
* Try to parse JSON, sanitized possible unescaped parts.
7979
*
8080
* @param json The json string
81-
* @throws Error when json could not be parsed
81+
* @throws {Error} when json could not be parsed
8282
*/
8383
function tryParseJSON(json: string) {
8484
try {

0 commit comments

Comments
 (0)