mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 15:11:15 +00:00
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.
35 lines
1.1 KiB
TypeScript
35 lines
1.1 KiB
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Type, Static } from '@sinclair/typebox';
|
|
|
|
export const GetStatusReturnSchema = Type.Object({
|
|
online: Type.Boolean({ description: '是否在线' }),
|
|
good: Type.Boolean({ description: '状态是否良好' }),
|
|
stat: Type.Unknown({ description: '统计信息' }),
|
|
});
|
|
|
|
export type GetStatusReturnType = Static<typeof GetStatusReturnSchema>;
|
|
|
|
export default class GetStatus extends OneBotAction<void, GetStatusReturnType> {
|
|
override actionName = ActionName.GetStatus;
|
|
override payloadSchema = Type.Object({});
|
|
override returnSchema = GetStatusReturnSchema;
|
|
override actionSummary = '获取运行状态';
|
|
override actionDescription = '获取运行状态';
|
|
override actionTags = ['系统接口'];
|
|
override payloadExample = {};
|
|
override returnExample = {
|
|
online: true,
|
|
good: true,
|
|
stat: {}
|
|
};
|
|
|
|
async _handle (): Promise<GetStatusReturnType> {
|
|
return {
|
|
online: !!this.core.selfInfo.online,
|
|
good: true,
|
|
stat: {},
|
|
};
|
|
}
|
|
}
|