mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-04 14:41:14 +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.
32 lines
1.2 KiB
TypeScript
32 lines
1.2 KiB
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
||
import { ActionName, BaseCheckResult } from '@/napcat-onebot/action/router';
|
||
import { Type } from '@sinclair/typebox';
|
||
|
||
export abstract class GetPacketStatusDepends<PT, RT> extends OneBotAction<PT, RT> {
|
||
protected override async check (payload: PT): Promise<BaseCheckResult> {
|
||
if (!this.core.apis.PacketApi.packetStatus) {
|
||
return {
|
||
valid: false,
|
||
message: 'packetBackend不可用,请参照文档 https://napneko.github.io/config/advanced 和启动日志检查packetBackend状态或进行配置!' +
|
||
'错误堆栈信息:' + this.core.apis.PacketApi.clientLogStack,
|
||
};
|
||
}
|
||
return await super.check(payload);
|
||
}
|
||
}
|
||
|
||
export class GetPacketStatus extends GetPacketStatusDepends<void, void> {
|
||
override actionName = ActionName.GetPacketStatus;
|
||
override payloadSchema = Type.Object({});
|
||
override returnSchema = Type.Null();
|
||
override actionSummary = '获取Packet状态';
|
||
override actionDescription = '获取底层Packet服务的运行状态';
|
||
override actionTags = ['系统接口'];
|
||
override payloadExample = {};
|
||
override returnExample = null;
|
||
|
||
async _handle () {
|
||
|
||
}
|
||
}
|