github-mirror/YesPlayMusic
github-mirror/YesPlayMusic
2
0
Fork 0
mirror of https://github.com/qier222/YesPlayMusic.git synced 2025-03-27 17:58:56 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: update jsdoc comments

Browse Source
This commit is contained in:
kunkka 2020-10-24 03:44:50 +08:00
parent b0e32c3f5f
commit bd1a170b0a
2 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/api/album.js
View File

@ -1,6 +1,11 @@
import request from "@/utils/request";
import { mapTrackPlayableStatus } from "@/utils/common";
/**
* 获取专辑内容
* 说明 : 调用此接口 , 传入专辑 id, 可获得专辑内容
* @param {number} id
*/
export function getAlbum(id) {
return request({
url: "/album",
@ -13,11 +18,15 @@ export function getAlbum(id) {
return data;
});
}
/**
* 全部新碟
* 说明 : 登录后调用此接口 ,可获取全部新碟
* @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:日本
*/
export function newAlbums(params) {
// limit : 返回数量 , 默认为 30
// offset : 偏移数量，用于分页 , 如 :( 页数 -1)*30, 其中 30 为 limit 的值 , 默认为 0
// area : ALL:全部,ZH:华语,EA:欧美,KR:韩国,JP:日本
return request({
url: "/album/new",
method: "get",

12
src/api/track.js
View File

@ -40,7 +40,7 @@ export function getTrackDetail(ids) {
/**
* 获取歌词
* 说明 : 调用此接口 , 传入音乐 id 可获得对应音乐的歌词 ( 不需要登录 )
* @param {number} id 音乐 id
* @param {number} id - 音乐 id
*/
export function getLyric(id) {
@ -55,7 +55,7 @@ export function getLyric(id) {
/**
* 新歌速递
* 说明 : 调用此接口 , 可获取新歌速递
* @param {number} type: 地区类型 id, 对应以下: 全部:0 华语:7 欧美:96 日本:8 韩国:16
* @param {number} type - 地区类型 id, 对应以下: 全部:0 华语:7 欧美:96 日本:8 韩国:16
*/
export function topSong(type) {
return request({
@ -70,7 +70,7 @@ export function topSong(type) {
* 喜欢音乐
* 说明 : 调用此接口 , 传入音乐 id, 可喜欢该音乐
* @param {Object} params
* @param {number} params.id: 歌曲 id,
* @param {number} params.id - 歌曲 id,
* @param {boolean=} [params.like] - 默认为 true 即喜欢 , 若传 false, 则取消喜欢
*/
export function likeATrack(params) {
@ -86,9 +86,9 @@ export function likeATrack(params) {
* 听歌打卡
* 说明 : 调用此接口 , 传入音乐 id, 来源 id，歌曲时间 time，更新听歌排行数据
* @param {Object} params
* @param {number} params.id: 歌曲 id,
* @param {number} params.sourceid: 歌单或专辑 id
* @param {number=} [params.time] 歌曲播放时间,单位为秒
* @param {number} params.id - 歌曲 id.
* @param {number} params.sourceid - 歌单或专辑 id
* @param {number=} [params.time] - 歌曲播放时间,单位为秒
*/
export function scrobble(params) {
params.timestamp = new Date().getTime();