Northern_Lights/NapCatQQ
1
0
Fork 0
mirror of https://github.com/NapNeko/NapCatQQ.git synced 2026-02-13 00:10:27 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add payload and return schemas to OneBot actions

Browse Source 
Introduced explicit payloadSchema and returnSchema definitions for all OneBotAction classes using @sinclair/typebox. This improves type safety, API documentation, and validation for action payloads and return values. Also refactored method signatures and types for consistency across the codebase.
This commit is contained in:
手瓜一十雪
2026-01-25 14:50:58 +08:00
parent 81e4e54f25
commit b69352f6a1
150 changed files with 2015 additions and 1235 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
packages/napcat-onebot/action/stream/DownloadFileStream.ts
View File

@@ -5,20 +5,21 @@ import { NetworkAdapterConfig } from '@/napcat-onebot/config/config';
import { StreamPacket, StreamStatus } from './StreamBasic';
import fs from 'fs';
import { BaseDownloadStream, DownloadResult } from './BaseDownloadStream';
const SchemaData = Type.Object({
file: Type.Optional(Type.String()),
file_id: Type.Optional(Type.String()),
chunk_size: Type.Optional(Type.Number({ default: 64 * 1024 })), // 默认64KB分块
const DownloadFileStreamPayloadSchema = Type.Object({
file: Type.Optional(Type.String({ description: '文件路径或 URL' })),
file_id: Type.Optional(Type.String({ description: '文件 ID' })),
chunk_size: Type.Optional(Type.Number({ default: 64 * 1024, description: '分块大小 (字节)' })), // 默认64KB分块
});
type Payload = Static<typeof SchemaData>;
export type DownloadFileStreamPayload = Static<typeof DownloadFileStreamPayloadSchema>;
export class DownloadFileStream extends BaseDownloadStream<Payload, DownloadResult> {
export class DownloadFileStream extends BaseDownloadStream<DownloadFileStreamPayload, DownloadResult> {
override actionName = ActionName.DownloadFileStream;
override payloadSchema = SchemaData;
override payloadSchema = DownloadFileStreamPayloadSchema;
override returnSchema = Type.Any({ description: '下载结果 (流式)' });
override useStream = true;
async _handle (payload: Payload, _adaptername: string, _config: NetworkAdapterConfig, req: OneBotRequestToolkit): Promise<StreamPacket<DownloadResult>> {
async _handle (payload: DownloadFileStreamPayload, _adaptername: string, _config: NetworkAdapterConfig, req: OneBotRequestToolkit): Promise<StreamPacket<DownloadResult>> {
try {
payload.file ||= payload.file_id || '';
const chunkSize = payload.chunk_size || 64 * 1024;