feat(DOC): 完整地审查了代码,更完整的注释说明

- 无代码修改
This commit is contained in:
tobegold574
2025-11-23 22:26:39 +08:00
parent 4e741a0523
commit c5853847ae
27 changed files with 119 additions and 110 deletions

View File

@@ -3,11 +3,13 @@ import type { ChatMessageType } from './enum';
// 创建聊天会话请求接口
export interface CreateChatSessionRequest {
// 对方的ID因为当前用户的id可以在session里获取cookie自动带上)
participantId: string;
}
// 更新聊天会话请求接口
// 更新聊天会话请求接口(占位)
export interface UpdateChatSessionRequest {
// 只能用于处理后台逻辑
sessionId: string;
}
@@ -57,7 +59,7 @@ export interface MarkMessagesAsReadRequest {
messageIds: string[];
}
// 标记消息已读响应接口
// 标记消息已读响应接口(已读状态只面向接收方)
export interface MarkMessagesAsReadResponse {
success: boolean;
markedMessageIds: string[]; // 成功标记的消息ID

View File

@@ -4,6 +4,7 @@ import type { ChatMessageType, ChatMessageStatus } from './enum';
// 聊天消息接口
export interface ChatMessage {
id: string;
// 聊天会话id下面那个接口的id
sessionId: string;
sender: User;
receiver: User;
@@ -16,6 +17,7 @@ export interface ChatMessage {
fileName?: string;
fileSize?: number;
duration?: number;
// 小图预览
thumbnail?: string;
[key: string]: unknown;
};

View File

@@ -1,4 +1,4 @@
// 聊天消息类型枚举
// 聊天消息类型枚举(暂时用不到的)
export enum ChatMessageType {
TEXT = 'text',
IMAGE = 'image',
@@ -8,7 +8,7 @@ export enum ChatMessageType {
SYSTEM = 'system'
}
// 聊天消息状态枚举
// 聊天消息状态枚举(暂时用不到的)
export enum ChatMessageStatus {
SENDING = 'sending',
SENT = 'sent',