From 29184740bfeb67dd8aebb3475e14b36218f5478a Mon Sep 17 00:00:00 2001 From: chenos Date: Fri, 5 Nov 2021 17:40:32 +0800 Subject: [PATCH] fix: update doc --- .../reverse-relationship-fields.md | 2 +- .../reverse-relationship-fields.zh-CN.md | 2 +- docs/reference/repository.md | 18 ++++++++---------- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/docs/guide/kernel-principle/reverse-relationship-fields.md b/docs/guide/kernel-principle/reverse-relationship-fields.md index 2e225a9cd3..c93d7e7bf4 100644 --- a/docs/guide/kernel-principle/reverse-relationship-fields.md +++ b/docs/guide/kernel-principle/reverse-relationship-fields.md @@ -258,4 +258,4 @@ const collection = db.collection({ collection.addField({ type: 'belongsTo', name: 'user' }); ``` -注:显式添加指的是代码配置上可见,隐式添加指的是自动生成,存在代码上但看不见。 +注:显式添加指的是代码配置上可见,隐式添加指的是自动生成,配置存在,但代码上但看不见。 diff --git a/docs/guide/kernel-principle/reverse-relationship-fields.zh-CN.md b/docs/guide/kernel-principle/reverse-relationship-fields.zh-CN.md index 2e225a9cd3..c93d7e7bf4 100644 --- a/docs/guide/kernel-principle/reverse-relationship-fields.zh-CN.md +++ b/docs/guide/kernel-principle/reverse-relationship-fields.zh-CN.md @@ -258,4 +258,4 @@ const collection = db.collection({ collection.addField({ type: 'belongsTo', name: 'user' }); ``` -注:显式添加指的是代码配置上可见,隐式添加指的是自动生成,存在代码上但看不见。 +注:显式添加指的是代码配置上可见,隐式添加指的是自动生成,配置存在,但代码上但看不见。 diff --git a/docs/reference/repository.md b/docs/reference/repository.md index 6de2a9e51d..c2aa20e95b 100644 --- a/docs/reference/repository.md +++ b/docs/reference/repository.md @@ -219,9 +219,7 @@ await Post.repository.find({ await Post.repository.find({ fields: ['id', 'name', 'tags'], }); -// -// [{ id, name, createdAt, updatedAt, tags: [{ id, name, createdAt, updatedAt }] }] - +// [{ id, name, tags: [{ id, name, createdAt, updatedAt }] }] ``` 可以只输出关系数据的某个字段 @@ -383,8 +381,8 @@ interface CreateOptions { // 字段黑名单 blacklist?: string[]; // 关系数据默认会新建并建立关联处理,如果是已存在的数据只关联,但不更新关系数据 - // 如果需要更新关联数据,可以通过 updateAssociations 指定 - updateAssociations?: string[]; + // 如果需要更新关联数据,可以通过 updateAssociationValues 指定 + updateAssociationValues?: string[]; } ``` @@ -496,7 +494,7 @@ await repository.create({ }], }, // 指定了 tags,建立关联时,也会同步修改 tag 数据 - updateAssociations: ['tags'], + updateAssociationValues: ['tags'], }); ``` @@ -530,8 +528,8 @@ await repository.create({ // 字段黑名单 blacklist: [], // 关系数据默认会新建并建立关联处理,如果是已存在的数据只关联,但不更新关系数据 - // 如果需要更新关联数据,可以通过 updateAssociations 指定 - updateAssociations: ['subTable'], + // 如果需要更新关联数据,可以通过 updateAssociationValues 指定 + updateAssociationValues: ['subTable'], }); ``` @@ -556,8 +554,8 @@ interface UpdateOptions { // 字段黑名单 blacklist?: string[]; // 关系数据默认会新建并建立关联处理,如果是已存在的数据只关联,但不更新关系数据 - // 如果需要更新关联数据,可以通过 updateAssociations 指定 - updateAssociations?: string[]; + // 如果需要更新关联数据,可以通过 updateAssociationValues 指定 + updateAssociationValues?: string[]; } ```