mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 07:01:16 +00:00
Introduced a centralized examples.ts file providing payload and return examples for all actions. Updated numerous action classes to include actionDescription, actionTags, payloadExample, and returnExample fields, improving API documentation and discoverability.
32 lines
1.1 KiB
TypeScript
32 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';
|
|
|
|
import { ActionExamples } from '../examples';
|
|
|
|
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 actionDescription = '获取运行状态';
|
|
override actionTags = ['系统接口'];
|
|
override payloadExample = ActionExamples.GetStatus.payload;
|
|
override returnExample = ActionExamples.GetStatus.return;
|
|
|
|
async _handle (): Promise<GetStatusReturnType> {
|
|
return {
|
|
online: !!this.core.selfInfo.online,
|
|
good: true,
|
|
stat: {},
|
|
};
|
|
}
|
|
}
|