Skip to content

Commit c171612

Browse files
committed
docs 修复部分锚点
1 parent 016a6e2 commit c171612

File tree

10 files changed

+38
-37
lines changed

10 files changed

+38
-37
lines changed

.github/copilot-instructions.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## 核心规则
44
1. **运行环境**: 所有脚本和命令优先使用 `bun` 运行。
55
2. **命令兼容性**: 在生成终端命令时,请注意 Windows 环境下不支持使用 `&&` 连接多个命令。应提供分步命令或使用兼容的替代方案。
6-
3. **内容**:
6+
3. **翻译内容**:
77
*`ccontent`(原文)为基准,仔细校对 `docs` 目录下的中文翻译内容,确保其准确、流畅。
88
* 删除所有 `@@switch` JavaScript 代码块部分。
99
* 比如 @@filename(rspress.config.ts) 参考 rspress 语法更改为 : ts title="rspress.config.ts"
@@ -12,7 +12,8 @@
1212
* awesome.md 和 index.md的 “docs.nestjs.com” 不要替换为 “docs.nestjs.cn”。
1313
* 网站的最终链接地址为 `https://docs.nestjs.cn`
1414
* 对于内部内容跳转,请将“docs.nestjs.com” 和 “docs.nestjs.cn” 改为使用相对路径,并需要并修正该真实路径, 例如 `./guide/introduction`
15-
4. **内容完整性**: 严格按照原文进行校对,不要添加任何未经请求的额外内容或个人解释。
15+
* 对于含有 "#" 的链接,如果后面是英文,请寻找对应的中文翻译链接。
16+
4. **内容完整性**: 严格按照原文进行校对,不要添加任何未经请求的额外内容或个人解释。
1617
5. **文档处理**:
1718
* 使用脚本需要防止文件乱码。
1819
*content 目录下的文件不需要处理。

docs/microservices/nats.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ const app = await NestFactory.createMicroservice<MicroserviceOptions>(AppModule,
3737

3838
#### 客户端
3939

40-
与其他微服务传输器类似,创建 NATS `ClientProxy` 实例时您有[多种选择](../microservices/basics#client)
40+
与其他微服务传输器类似,创建 NATS `ClientProxy` 实例时您有[多种选择](../microservices/basics#客户端生产者类)
4141

42-
一种创建实例的方法是使用 `ClientsModule`。要通过 `ClientsModule` 创建客户端实例,需先导入该模块,然后使用 `register()` 方法传入一个选项对象,该对象包含与上述 `createMicroservice()` 方法相同的属性,以及用作注入令牌的 `name` 属性。更多关于 `ClientsModule` 的信息请参阅[此处](../microservices/basics#client)
42+
一种创建实例的方法是使用 `ClientsModule`。要通过 `ClientsModule` 创建客户端实例,需先导入该模块,然后使用 `register()` 方法传入一个选项对象,该对象包含与上述 `createMicroservice()` 方法相同的属性,以及用作注入令牌的 `name` 属性。更多关于 `ClientsModule` 的信息请参阅[此处](../microservices/basics#客户端生产者类)
4343

4444
```typescript
4545
@Module({
@@ -58,15 +58,15 @@ const app = await NestFactory.createMicroservice<MicroserviceOptions>(AppModule,
5858
})
5959
```
6060

61-
也可以使用其他创建客户端的方法(`ClientProxyFactory``@Client()`)。相关说明可查看[此文档](../microservices/basics#client)
61+
也可以使用其他创建客户端的方法(`ClientProxyFactory``@Client()`)。相关说明可查看[此文档](../microservices/basics#客户端生产者类)
6262

6363
#### 请求-响应模式
6464

65-
对于**请求-响应**消息模式( [了解更多](../microservices/basics#request-response) ),NATS 传输器不使用 NATS 内置的[请求-应答](https://docs.nats.io/nats-concepts/reqreply)机制。相反,"请求"通过带有唯一回复主题名称的 `publish()` 方法在给定主题上发布,响应者监听该主题并将响应发送至回复主题。无论双方位置如何,回复主题都会动态定向回请求方。
65+
对于**请求-响应**消息模式( [了解更多](../microservices/basics#请求-响应) ),NATS 传输器不使用 NATS 内置的[请求-应答](https://docs.nats.io/nats-concepts/reqreply)机制。相反,"请求"通过带有唯一回复主题名称的 `publish()` 方法在给定主题上发布,响应者监听该主题并将响应发送至回复主题。无论双方位置如何,回复主题都会动态定向回请求方。
6666

6767
#### 基于事件
6868

69-
对于**基于事件**的消息模式( [了解更多](../microservices/basics#event-based) ),NATS 传输器使用 NATS 内置的[发布-订阅](https://docs.nats.io/nats-concepts/pubsub)机制。发布者在主题上发送消息,任何监听该主题的活跃订阅者都会收到消息。订阅者还可以注册对通配符主题的兴趣,这些通配符主题的工作方式有点像正则表达式。这种一对多模式有时被称为扇出。
69+
对于**基于事件**的消息模式( [了解更多](../microservices/basics#基于事件) ),NATS 传输器使用 NATS 内置的[发布-订阅](https://docs.nats.io/nats-concepts/pubsub)机制。发布者在主题上发送消息,任何监听该主题的活跃订阅者都会收到消息。订阅者还可以注册对通配符主题的兴趣,这些通配符主题的工作方式有点像正则表达式。这种一对多模式有时被称为扇出。
7070

7171
#### 队列组
7272

docs/migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,4 +355,4 @@ $ npm install -g @nestjs/mau
355355
$ mau deploy
356356
```
357357

358-
您可以在[本章节](./deployment.md#使用-mau-轻松部署)中了解更多关于 Mau 的信息
358+
您可以在[部署指南](./deployment.md)中了解更多关于部署的信息

docs/techniques/caching.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ CacheModule.register({
142142

143143
#### 全局缓存覆盖
144144

145-
当启用全局缓存时,缓存条目会存储在基于路由路径自动生成的 `CacheKey` 下。您可以在每个方法基础上覆盖特定的缓存设置(`@CacheKey()``@CacheTTL()`),从而为单个控制器方法定制缓存策略。这在需要使用[不同缓存存储](./caching#different-stores)时可能最为相关。
145+
当启用全局缓存时,缓存条目会存储在基于路由路径自动生成的 `CacheKey` 下。您可以在每个方法基础上覆盖特定的缓存设置(`@CacheKey()``@CacheTTL()`),从而为单个控制器方法定制缓存策略。这在需要使用[不同缓存存储](./caching#使用其他缓存存储方案)时可能最为相关。
146146

147147
您可以在控制器级别应用 `@CacheTTL()` 装饰器,为整个控制器设置缓存 TTL。当同时定义了控制器级别和方法级别的缓存 TTL 设置时,方法级别指定的缓存 TTL 设置将优先于控制器级别的设置。
148148

@@ -160,7 +160,7 @@ export class AppController {
160160

161161
> info **提示** `@CacheKey()``@CacheTTL()` 装饰器是从 `@nestjs/cache-manager` 包导入的。
162162
163-
`@CacheKey()` 装饰器可以单独使用,也可以与 `@CacheTTL()` 装饰器配合使用,反之亦然。开发者可以选择仅覆盖 `@CacheKey()` 或仅覆盖 `@CacheTTL()`。未被装饰器覆盖的配置将使用全局注册的默认值(参见[自定义缓存](./caching#customize-caching) )。
163+
`@CacheKey()` 装饰器可以单独使用,也可以与 `@CacheTTL()` 装饰器配合使用,反之亦然。开发者可以选择仅覆盖 `@CacheKey()` 或仅覆盖 `@CacheTTL()`。未被装饰器覆盖的配置将使用全局注册的默认值(参见[自定义缓存](./caching) )。
164164

165165
#### WebSocket 与微服务
166166

docs/techniques/cookies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ findAll(@Res({ passthrough: true }) response: Response) {
4949
}
5050
```
5151

52-
> warning **警告** 如果希望将响应处理逻辑交由框架处理,请记得将 `passthrough` 选项设为 `true`,如上所示。更多信息请参阅 [此处](/controllers#library-specific-approach)
52+
> warning **警告** 如果希望将响应处理逻辑交由框架处理,请记得将 `passthrough` 选项设为 `true`,如上所示。更多信息请参阅 [此处](/overview/controllers#库特定方法)
5353
5454
> info **提示** `@Res()` 装饰器从 `@nestjs/common` 导入,而 `Response` 则来自 `express` 包。
5555
@@ -98,7 +98,7 @@ findAll(@Res({ passthrough: true }) response: FastifyReply) {
9898

9999
要了解更多关于 `FastifyReply#setCookie()` 方法的信息,请查看此[页面](https://github.com/fastify/fastify-cookie#sending)
100100

101-
> warning **警告** 如果希望将响应处理逻辑交由框架处理,请记得将 `passthrough` 选项设为 `true`,如上所示。更多信息请参阅 [此处](/controllers#library-specific-approach)
101+
> warning **警告** 如果希望将响应处理逻辑交由框架处理,请记得将 `passthrough` 选项设为 `true`,如上所示。更多信息请参阅 [此处](/overview/controllers#库特定方法)
102102
103103
> info **提示** `@Res()` 装饰器从 `@nestjs/common` 导入,而 `FastifyReply` 则来自 `fastify` 包。
104104

docs/techniques/logger.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,11 +241,11 @@ export class MyLogger extends ConsoleLogger {
241241
}
242242
```
243243

244-
您可以在功能模块中使用这种扩展的日志记录器,具体方法如下文[使用日志记录器进行应用日志记录](techniques/logger#using-the-logger-for-application-logging)部分所述。
244+
您可以在功能模块中使用这种扩展的日志记录器,具体方法如下文[使用日志记录器进行应用程序日志记录](techniques/logger#使用日志记录器进行应用程序日志记录)部分所述。
245245

246-
您可以通过以下两种方式让 Nest 使用您扩展的日志记录器进行系统日志记录:1) 将其实例通过应用程序选项对象的 `logger` 属性传递(如上方[自定义实现](techniques/logger#custom-logger-implementation)部分所示);2) 使用下文[依赖注入](techniques/logger#dependency-injection)部分展示的技术。如果这样做,请注意如示例代码所示调用 `super`,将特定的日志方法调用委托给父类(内置类),以确保 Nest 能够依赖其预期的内置功能。
246+
您可以通过以下两种方式让 Nest 使用您扩展的日志记录器进行系统日志记录:1) 将其实例通过应用程序选项对象的 `logger` 属性传递(如上方[自定义实现](techniques/logger#自定义实现)部分所示);2) 使用下文[依赖注入](techniques/logger#依赖注入)部分展示的技术。如果这样做,请注意如示例代码所示调用 `super`,将特定的日志方法调用委托给父类(内置类),以确保 Nest 能够依赖其预期的内置功能。
247247

248-
#### Dependency injection
248+
#### 依赖注入
249249

250250
要实现更高级的日志功能,您需要利用依赖注入。例如,您可能希望将 `ConfigService` 注入到日志记录器中以进行自定义配置,然后再将这个自定义日志记录器注入到其他控制器和/或提供程序中。要使自定义日志记录器支持依赖注入,需要创建一个实现 `LoggerService` 的类,并将该类作为提供程序注册到某个模块中。例如,您可以
251251

@@ -281,7 +281,7 @@ await app.listen(process.env.PORT ?? 3000);
281281
282282
这里我们在 `NestApplication` 实例上使用 `get()` 方法来获取 `MyLogger` 对象的单例实例。这种技术本质上是一种为 Nest "注入"日志记录器实例以供使用的方式。`app.get()` 调用会获取 `MyLogger` 的单例实例,并依赖于该实例首先在另一个模块中被注入,如上所述。
283283

284-
您也可以在功能类中注入这个 `MyLogger` 提供者,从而确保 Nest 系统日志和应用日志记录行为的一致性。更多信息请参阅下方的[使用日志记录器进行应用日志记录](techniques/logger#using-the-logger-for-application-logging)[注入自定义日志记录器](techniques/logger#injecting-a-custom-logger)
284+
您也可以在功能类中注入这个 `MyLogger` 提供者,从而确保 Nest 系统日志和应用日志记录行为的一致性。更多信息请参阅下方的[使用日志记录器进行应用程序日志记录](techniques/logger#使用日志记录器进行应用程序日志记录)[注入自定义日志记录器](techniques/logger#注入自定义日志记录器)
285285

286286
#### 注入自定义日志记录器
287287

0 commit comments

Comments
 (0)