refactor: add type definitions for API responses

This commit is contained in:
pa
2025-07-16 13:31:48 +09:00
committed by Natsumi
parent 342850dc7e
commit 0e50a67c25
17 changed files with 601 additions and 206 deletions

View File

@@ -3,7 +3,7 @@ import { useUserStore } from '../stores';
const avatarReq = {
/**
* @type {import('../types/avatar').getAvatar}
* @type {import('../types/api/avatar').GetAvatar}
*/
getAvatar(params) {
return request(`avatars/${params.avatarId}`, {
@@ -18,22 +18,7 @@ const avatarReq = {
},
/**
* @typedef {{
* n: number,
* offset: number,
* search: string,
* userId: string,
* user: 'me' | 'friends'
* sort: 'created' | 'updated' | 'order' | '_created_at' | '_updated_at',
* order: 'ascending' | 'descending',
* releaseStatus: 'public' | 'private' | 'hidden' | 'all',
* featured: boolean
* }} GetAvatarsParameter
*/
/**
*
* @param {GetAvatarsParameter} params
* @returns {Promise<{json: any, params}>}
* @type {import('../types/api/avatar').GetAvatars}
*/
getAvatars(params) {
return request('avatars', {