girineko/YesPlayMusic
1
0
Fork 0
mirror of https://github.com/GiriNeko/YesPlayMusic.git synced 2025-12-18 06:07:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: update jsdoc comments

Browse source
This commit is contained in:
kunkka 2020-10-24 03:19:25 +08:00
parent 63bf87fa04
commit b0e32c3f5f
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/api/track.js
View file

@ -48,7 +48,7 @@ export function getLyric(id) {
url: "/lyric", url: "/lyric",
method: "get", method: "get",
params: { params: {
id: id, id,
}, },
}); });
} }
@ -69,8 +69,9 @@ export function topSong(type) {
/** /**
* 喜欢音乐 * 喜欢音乐
* 说明 : 调用此接口 , 传入音乐 id, 可喜欢该音乐 * 说明 : 调用此接口 , 传入音乐 id, 可喜欢该音乐
* @param {number} id: 歌曲 id, * @param {Object} params
* @param {boolean} like: 默认为 true 即喜欢 , 若传 false, 则取消喜欢 * @param {number} params.id: 歌曲 id,
* @param {boolean=} [params.like] - 默认为 true 即喜欢 , 若传 false, 则取消喜欢
*/ */
export function likeATrack(params) { export function likeATrack(params) {
params.timestamp = new Date().getTime(); params.timestamp = new Date().getTime();
@ -84,9 +85,10 @@ export function likeATrack(params) {
/** /**
* 听歌打卡 * 听歌打卡
* 说明 : 调用此接口 , 传入音乐 id, 来源 id，歌曲时间 time，更新听歌排行数据 * 说明 : 调用此接口 , 传入音乐 id, 来源 id，歌曲时间 time，更新听歌排行数据
* @param {number} id: 歌曲 id, * @param {Object} params
* @param {number} sourceid: 歌单或专辑 id * @param {number} params.id: 歌曲 id,
* @param {number} [time] 歌曲播放时间,单位为秒 * @param {number} params.sourceid: 歌单或专辑 id
* @param {number=} [params.time] 歌曲播放时间,单位为秒
*/ */
export function scrobble(params) { export function scrobble(params) {
params.timestamp = new Date().getTime(); params.timestamp = new Date().getTime();