nicot 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -0
- package/dist/index.cjs.map +2 -2
- package/dist/index.mjs.map +2 -2
- package/dist/src/restful.d.ts +21 -21
- package/dist/src/utility/omit-from-class.d.ts +3 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -520,6 +520,26 @@ isActive: boolean;
|
|
|
520
520
|
|
|
521
521
|
---
|
|
522
522
|
|
|
523
|
+
### RestfulFactory 配置项
|
|
524
|
+
|
|
525
|
+
```ts
|
|
526
|
+
export interface RestfulFactoryOptions<T> {
|
|
527
|
+
fieldsToOmit?: (keyof T)[]; // 不出现在任何输入 DTO 中的字段
|
|
528
|
+
writeFieldsToOmit?: (keyof T)[]; // 不出现在创建与更新 DTO 中的字段
|
|
529
|
+
createFieldsToOmit?: (keyof T)[]; // 不出现在创建 DTO 中的字段
|
|
530
|
+
updateFieldsToOmit?: (keyof T)[]; // 不出现在更新 DTO 中的字段
|
|
531
|
+
findAllFieldsToOmit?: (keyof T)[]; // 不出现在查询 DTO 中的字段
|
|
532
|
+
outputFieldsToOmit?: (keyof T)[]; // 不出现在任何输出 DTO 中的字段
|
|
533
|
+
prefix?: string; // 接口的路由前缀
|
|
534
|
+
keepEntityVersioningDates?: boolean; // 在返回结果中保留实体的 createTime / updateTime 字段
|
|
535
|
+
entityClassName?: string; // 实体类名称，如果存在同一 Entity 的多个 RestfulFactory 实例时需要指定，避免 OpenAPI 类型冲突
|
|
536
|
+
relations?: (string | RelationDef)[]; // 关联加载的关系字段，传给 CrudService 的 relations 参数，以及用于生成关系 DTO
|
|
537
|
+
skipNonQueryableFields?: boolean; // 在查询 DTO 中跳过所有没有 @QueryXXX() 装饰器的字段
|
|
538
|
+
}
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
---
|
|
542
|
+
|
|
523
543
|
### 示例 Controller
|
|
524
544
|
|
|
525
545
|
```ts
|