From b0e32c3f5fb6c7e02598b44f264bcfc54a6f050f Mon Sep 17 00:00:00 2001 From: kunkka Date: Sat, 24 Oct 2020 03:19:25 +0800 Subject: [PATCH] feat: update jsdoc comments --- src/api/track.js | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/api/track.js b/src/api/track.js index 725eec0..ad0a929 100644 --- a/src/api/track.js +++ b/src/api/track.js @@ -48,7 +48,7 @@ export function getLyric(id) { url: "/lyric", method: "get", params: { - id: id, + id, }, }); } @@ -69,8 +69,9 @@ export function topSong(type) { /** * 喜欢音乐 * 说明 : 调用此接口 , 传入音乐 id, 可喜欢该音乐 - * @param {number} id: 歌曲 id, - * @param {boolean} like: 默认为 true 即喜欢 , 若传 false, 则取消喜欢 + * @param {Object} params + * @param {number} params.id: 歌曲 id, + * @param {boolean=} [params.like] - 默认为 true 即喜欢 , 若传 false, 则取消喜欢 */ export function likeATrack(params) { params.timestamp = new Date().getTime(); @@ -84,9 +85,10 @@ export function likeATrack(params) { /** * 听歌打卡 * 说明 : 调用此接口 , 传入音乐 id, 来源 id,歌曲时间 time,更新听歌排行数据 - * @param {number} id: 歌曲 id, - * @param {number} sourceid: 歌单或专辑 id - * @param {number} [time] 歌曲播放时间,单位为秒 + * @param {Object} params + * @param {number} params.id: 歌曲 id, + * @param {number} params.sourceid: 歌单或专辑 id + * @param {number=} [params.time] 歌曲播放时间,单位为秒 */ export function scrobble(params) { params.timestamp = new Date().getTime();