docs: update jsdoc comments

master
kunkka 4 years ago
parent bd1a170b0a
commit 51da17d1b9

@ -21,10 +21,13 @@ export function getAlbum(id) {
/**
* 全部新碟
* 说明 : 登录后调用此接口 ,可获取全部新碟
* - limit - 返回数量 , 默认为 30
* - offset - 偏移数量用于分页 , :( 页数 -1)*30, 其中 30 limit 的值 , 默认为 0
* - area - ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本
* @param {Object} params
* @param {number} params.limit - 返回数量 , 默认为 30
* @param {number=} params.offset - 偏移数量用于分页 , :( 页数 -1)*30, 其中 30 limit 的值 , 默认为 0
* @param {string} params.area - ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本
* @param {number} params.limit
* @param {number=} params.offset
* @param {string} params.area
*/
export function newAlbums(params) {
return request({

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

Loading…
Cancel
Save