yoone
/
API
1
0
Fork 3
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

docs(dto): 修正注释中的括号格式

This commit is contained in:
tikkhun 2026-01-08 18:57:51 +08:00
parent a5ab693852
commit 44a7578c50
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/dto/batch.dto.ts
View File

@ -5,7 +5,7 @@ import { Rule, RuleType } from '@midwayjs/validate';
* 批量操作错误项 * 批量操作错误项
*/ */
export interface BatchErrorItem { export interface BatchErrorItem {
// 错误项标识(可以是ID、邮箱等） // 错误项标识(可以是ID、邮箱等)
identifier: string; identifier: string;
// 错误信息 // 错误信息
error: string; error: string;
@ -25,7 +25,7 @@ export interface BatchOperationResult {
updated?: number; updated?: number;
// 删除数量 // 删除数量
deleted?: number; deleted?: number;
// 跳过的数量(如数据已存在或无需处理） // 跳过的数量(如数据已存在或无需处理)
skipped?: number; skipped?: number;
// 错误列表 // 错误列表
errors: BatchErrorItem[]; errors: BatchErrorItem[];
@ -43,7 +43,7 @@ export interface SyncOperationResult extends BatchOperationResult {
* 批量操作错误项DTO * 批量操作错误项DTO
*/ */
export class BatchErrorItemDTO { export class BatchErrorItemDTO {
@ApiProperty({ description: '错误项标识(如ID、邮箱等）', type: String }) @ApiProperty({ description: '错误项标识(如ID、邮箱等)', type: String })
@Rule(RuleType.string().required()) @Rule(RuleType.string().required())
identifier: string; identifier: string;
@ -114,7 +114,7 @@ export class BatchDeleteDTO {
} }
/** /**
* 批量操作请求DTO(包含增删改） * 批量操作请求DTO(包含增删改)
*/ */
export class BatchOperationDTO<T = any> { export class BatchOperationDTO<T = any> {
@ApiProperty({ description: '要创建的数据列表', type: Array, required: false }) @ApiProperty({ description: '要创建的数据列表', type: Array, required: false })
@ -175,7 +175,7 @@ export class SyncParamsDTO {
@Rule(RuleType.string().optional()) @Rule(RuleType.string().optional())
endDate?: string; endDate?: string;
@ApiProperty({ description: '强制同步(忽略缓存）', type: Boolean, required: false, default: false }) @ApiProperty({ description: '强制同步(忽略缓存)', type: Boolean, required: false, default: false })
@Rule(RuleType.boolean().optional()) @Rule(RuleType.boolean().optional())
force?: boolean = false; force?: boolean = false;
} }
@ -194,7 +194,7 @@ export class BatchQueryDTO {
} }
/** /**
* 批量操作结果类(泛型支持） * 批量操作结果类(泛型支持)
*/ */
export class BatchOperationResultDTOGeneric<T> extends BatchOperationResultDTO { export class BatchOperationResultDTOGeneric<T> extends BatchOperationResultDTO {
@ApiProperty({ description: '操作成功的数据列表', type: Array }) @ApiProperty({ description: '操作成功的数据列表', type: Array })
@ -202,7 +202,7 @@ export class BatchOperationResultDTOGeneric<T> extends BatchOperationResultDTO {
} }
/** /**
* 同步操作结果类(泛型支持） * 同步操作结果类(泛型支持)
*/ */
export class SyncOperationResultDTOGeneric<T> extends SyncOperationResultDTO { export class SyncOperationResultDTOGeneric<T> extends SyncOperationResultDTO {
@ApiProperty({ description: '同步成功的数据列表', type: Array }) @ApiProperty({ description: '同步成功的数据列表', type: Array })