NapCatQQ/packages/napcat-onebot/action/user/SendLike.ts
手瓜一十雪 60a9114495 Add action metadata to OneBot action classes
Added or updated actionSummary, actionTags, payloadExample, and returnExample properties for all OneBot action classes in the napcat-onebot package. This improves API documentation and discoverability by providing concise summaries, categorization tags, and usage examples for each action.
2026-01-25 19:19:03 +08:00

40 lines
1.4 KiB
TypeScript

import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
import { ActionName } from '@/napcat-onebot/action/router';
import { Static, Type } from '@sinclair/typebox';
import { ActionExamples } from '../examples';
export const SendLikePayloadSchema = Type.Object({
user_id: Type.String({ description: '对方 QQ 号' }),
times: Type.Union([Type.Number(), Type.String()], { default: 1, description: '点赞次数' }),
});
export type SendLikePayload = Static<typeof SendLikePayloadSchema>;
export default class SendLike extends OneBotAction<SendLikePayload, void> {
override actionName = ActionName.SendLike;
override payloadSchema = SendLikePayloadSchema;
override returnSchema = Type.Null();
override actionSummary = '点赞';
override actionDescription = '给指定用户点赞';
override actionTags = ['用户接口'];
override payloadExample = {
user_id: '123456',
times: 10
};
override returnExample = {};
override errorExamples = [
...ActionExamples.Common.errors,
{ code: 1400, description: '点赞失败(频率过快或用户不存在)' }
];
async _handle (payload: SendLikePayload): Promise<void> {
const qq = payload.user_id.toString();
const uid: string = await this.core.apis.UserApi.getUidByUinV2(qq) ?? '';
const result = await this.core.apis.UserApi.like(uid, +payload.times);
if (result.result !== 0) {
throw new Error(`点赞失败 ${result.errMsg}`);
}
}
}