Skip to content

Commit c06871f

Browse files
committed
chore() 修复模板语法
1 parent 942e65d commit c06871f

19 files changed

+225
-34
lines changed

docs/devtools/ci-cd.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,22 +101,22 @@ jobs:
101101
- name: Install dependencies
102102
run: npm ci
103103
- name: Setup Environment (PR)
104-
if: {{ '${{' }} github.event_name == 'pull_request' {{ '}}' }}
104+
if: ${{ github.event_name == 'pull_request' }}
105105
shell: bash
106106
run: |
107-
echo "COMMIT_SHA={{ '${{' }} github.event.pull_request.head.sha {{ '}}' }}" >>\${GITHUB_ENV}
107+
echo "COMMIT_SHA=${{ github.event.pull_request.head.sha }}" >>${GITHUB_ENV}
108108
- name: Setup Environment (Push)
109-
if: {{ '${{' }} github.event_name == 'push' {{ '}}' }}
109+
if: ${{ github.event_name == 'push' }}
110110
shell: bash
111111
run: |
112-
echo "COMMIT_SHA=\${GITHUB_SHA}" >> \${GITHUB_ENV}
112+
echo "COMMIT_SHA=${GITHUB_SHA}" >> ${GITHUB_ENV}
113113
- name: Publish
114114
run: PUBLISH_GRAPH=true npm run start
115115
env:
116116
DEVTOOLS_API_KEY: CHANGE_THIS_TO_YOUR_API_KEY
117-
REPOSITORY_NAME: {{ '${{' }} github.event.repository.name {{ '}}' }}
118-
BRANCH_NAME: {{ '${{' }} github.head_ref || github.ref_name {{ '}}' }}
119-
TARGET_SHA: {{ '${{' }} github.event.pull_request.base.sha {{ '}}' }}
117+
REPOSITORY_NAME: ${{ github.event.repository.name }}
118+
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
119+
TARGET_SHA: ${{ github.event.pull_request.base.sha }}
120120
```
121121

122122
理想情况下,`DEVTOOLS_API_KEY` 环境变量应从 GitHub Secrets 中获取,更多信息请参阅[此处](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) 。

docs/faq/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Nest 无法解析 <provider> 的依赖项(?)。
6363
解决方案:
6464

6565
- 对于 **Yarn** Workspaces,使用 [nohoist 特性](https://classic.yarnpkg.com/blog/2018/02/15/nohoist)来阻止提升 `@nestjs/core` 包。
66-
- 对于 **pnpm** 工作区,请在其他模块中将 `@nestjs/core` 设置为 peerDependencies,并在导入该模块的应用 package.json 中添加 `"dependenciesMeta": {{ '{' }}"other-module-name": {{ '{' }}"injected": true &#125;&#125;` 。参见:[dependenciesmetainjected](https://pnpm.io/package_json#dependenciesmetainjected)
66+
- 对于 **pnpm** 工作区,请在其他模块中将 `@nestjs/core` 设置为 peerDependencies,并在导入该模块的应用 package.json 中添加 `"dependenciesMeta": {"other-module-name": {"injected": true}}` 。参见:[dependenciesmetainjected](https://pnpm.io/package_json#dependenciesmetainjected)
6767

6868
#### "循环依赖"错误
6969

docs/fundamentals/dynamic-modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ export const CONFIG_OPTIONS = 'CONFIG_OPTIONS';
273273

274274
当创建模块时:
275275

276-
- `register`,表示你希望配置一个动态模块,该配置仅由调用模块使用。例如,使用 Nest 的 `@nestjs/axios``HttpModule.register({{ '{' }} baseUrl: 'someUrl' {{ '}' }})` 。如果在另一个模块中使用 `HttpModule.register({{ '{' }} baseUrl: 'somewhere else' {{ '}' }})` ,它将具有不同的配置。你可以根据需要为任意多个模块进行此操作。
276+
- `register`,表示你希望配置一个动态模块,该配置仅由调用模块使用。例如,使用 Nest 的 `@nestjs/axios``HttpModule.register({ baseUrl: 'someUrl' })` 。如果在另一个模块中使用 `HttpModule.register({ baseUrl: 'somewhere else' })` ,它将具有不同的配置。你可以根据需要为任意多个模块进行此操作。
277277
- `forRoot`,表示你希望一次性配置动态模块,并在多个地方复用该配置(尽管可能由于抽象而不知情)。这就是为什么你只有一个 `GraphQLModule.forRoot()`、一个 `TypeOrmModule.forRoot()` 等。
278278
- `forFeature`,表示你希望使用动态模块的 `forRoot` 配置,但需要根据调用模块的需求修改某些特定配置(例如该模块应访问哪些存储库,或记录器应使用的上下文)。
279279

docs/graphql/field-middleware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const loggerMiddleware: FieldMiddleware = async (
2323
};
2424
```
2525

26-
> info **提示** `MiddlewareContext` 是一个包含与 GraphQL 解析器函数通常接收的相同参数的对象 ( `{{ '{' }} source, args, context, info {{ '}' }}` ),而 `NextFn` 是一个允许您执行堆栈中下一个中间件(绑定到此字段)或实际字段解析器的函数。
26+
> info **提示** `MiddlewareContext` 是一个包含与 GraphQL 解析器函数通常接收的相同参数的对象 ( `{ source, args, context, info }` ),而 `NextFn` 是一个允许您执行堆栈中下一个中间件(绑定到此字段)或实际字段解析器的函数。
2727
2828
> warning **注意** 字段中间件函数无法注入依赖项也无法访问 Nest 的 DI 容器,因为它们被设计得非常轻量级且不应执行任何可能耗时的操作(如从数据库检索数据)。如果您需要调用外部服务/从数据源查询数据,应在绑定到根查询/变更处理程序的守卫/拦截器中完成,并将其分配给可从字段中间件内部(特别是从 `MiddlewareContext` 对象中)访问的 `context` 对象。
2929

docs/graphql/resolvers-map.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ type Author {
7777
title: string;
7878
```
7979

80-
info **提示** 你也可以为整个对象类型添加描述或标记为已弃用: `@ObjectType({{ '{' }} description: 'Author model' {{ '}' }})`
80+
info **提示** 你也可以为整个对象类型添加描述或标记为已弃用: `@ObjectType({ description: 'Author model' })`
8181

8282
当字段为数组类型时,必须在 `Field()` 装饰器的类型函数中手动声明数组类型,如下所示:
8383

@@ -222,7 +222,7 @@ type Query {
222222

223223
#### 查询装饰器选项
224224

225-
`@Query()` 装饰器的选项对象(我们在上面传递 `{{ '{' }}name: 'author'{{ '}' }}` 的地方)接受多个键/值对:
225+
`@Query()` 装饰器的选项对象(我们在上面传递 `{name: 'author'}` 的地方)接受多个键/值对:
226226

227227
- `name`: 查询名称;一个 `string` 类型
228228
- `description`: 用于生成 GraphQL 模式文档的描述(例如在 GraphQL playground 中);一个 `string` 类型

docs/graphql/subscriptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ type Subscription {
9898
}
9999
```
100100

101-
这表明订阅必须返回一个顶层属性名为 `commentAdded` 的对象,其值为 `Comment` 对象。关键点在于:`PubSub#publish` 方法发出的事件负载结构必须与订阅预期的返回值结构相对应。因此在上例中, `pubSub.publish('commentAdded', {{ '{' }} commentAdded: newComment {{ '}' }})` 语句发布了带有正确结构负载的 `commentAdded` 事件。如果结构不匹配,您的订阅将在 GraphQL 验证阶段失败。
101+
这表明订阅必须返回一个顶层属性名为 `commentAdded` 的对象,其值为 `Comment` 对象。关键点在于:`PubSub#publish` 方法发出的事件负载结构必须与订阅预期的返回值结构相对应。因此在上例中, `pubSub.publish('commentAdded', { commentAdded: newComment })` 语句发布了带有正确结构负载的 `commentAdded` 事件。如果结构不匹配,您的订阅将在 GraphQL 验证阶段失败。
102102

103103
#### 过滤订阅内容
104104

@@ -127,7 +127,7 @@ commentAdded() {
127127
}
128128
```
129129

130-
> warning **注意** 如果使用 `resolve` 选项,应当返回未经包装的有效载荷(例如在我们的示例中,直接返回 `newComment` 对象,而非 `{{ '{' }} commentAdded: newComment {{ '}' }}` 对象)。
130+
> warning **注意** 如果使用 `resolve` 选项,应当返回未经包装的有效载荷(例如在我们的示例中,直接返回 `newComment` 对象,而非 `{ commentAdded: newComment }` 对象)。
131131
132132
如需访问注入的提供程序(例如使用外部服务验证数据),请采用以下构造方式。
133133

@@ -435,7 +435,7 @@ type Subscription {
435435
}
436436
```
437437

438-
这表明订阅必须返回一个顶级属性名为 `commentAdded` 的对象,其值为 `Comment` 对象。关键点在于:`PubSub#publish` 方法发出的事件负载结构必须与订阅期望返回值的结构相对应。因此在上例中, `pubSub.publish({{ '{' }} topic: 'commentAdded', payload: {{ '{' }} commentAdded: newComment {{ '}' }} {{ '}' }})` 语句发布的 `commentAdded` 事件带有正确结构的负载。若结构不匹配,订阅将在 GraphQL 验证阶段失败。
438+
这表明订阅必须返回一个顶级属性名为 `commentAdded` 的对象,其值为 `Comment` 对象。关键点在于:`PubSub#publish` 方法发出的事件负载结构必须与订阅期望返回值的结构相对应。因此在上例中, `pubSub.publish({ topic: 'commentAdded', payload: { commentAdded: newComment } })` 语句发布的 `commentAdded` 事件带有正确结构的负载。若结构不匹配,订阅将在 GraphQL 验证阶段失败。
439439

440440
#### 订阅过滤
441441

docs/microservices/basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ export class MathController {
120120
}
121121
```
122122

123-
在上述代码中,`accumulate()` **消息处理器**会监听与 `{{ '{' }} cmd: 'sum' {{ '}' }}` 消息模式匹配的消息。该消息处理器接收一个参数,即客户端传递的 `data`。在本例中,数据是需要累加的数字数组。
123+
在上述代码中,`accumulate()` **消息处理器**会监听与 `{ cmd: 'sum' }` 消息模式匹配的消息。该消息处理器接收一个参数,即客户端传递的 `data`。在本例中,数据是需要累加的数字数组。
124124

125125
#### 异步响应
126126

docs/overview/controllers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ findAll() {
157157

158158
这种方式在 Express 和 Fastify 上都适用。不过随着 Express 最新版本(v5)的发布,路由系统变得更加严格。在纯 Express 中,必须使用命名通配符才能使路由生效——例如 `abcd/*splat`,其中 `splat` 只是通配参数的名称,没有特殊含义。您可以随意命名。也就是说,由于 Nest 为 Express 提供了兼容层,您仍然可以使用星号(`*`)作为通配符。
159159

160-
当星号用于**路由中间**时,Express 要求使用命名通配符(例如 `ab{{ '{' }}*splat&#125;cd`),而 Fastify 则完全不支持这种用法。
160+
当星号用于**路由中间**时,Express 要求使用命名通配符(例如 `ab{*splat}cd`),而 Fastify 则完全不支持这种用法。
161161

162162
#### 状态码
163163

docs/overview/first-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ bootstrap();
263263

264264
需要注意的是,使用 Nest CLI 搭建的项目会创建一个初始项目结构,该结构鼓励开发者遵守将每个模块保存在其专属目录中的约定。
265265

266-
> info **提示** 默认情况下,如果在创建应用程序时发生任何错误,你的应用将以代码 `1` 退出。若希望改为抛出错误,请禁用 `abortOnError` 选项(例如, `NestFactory.create(AppModule, {{ '{' }} abortOnError: false {{ '}' }})` )。
266+
> info **提示** 默认情况下,如果在创建应用程序时发生任何错误,你的应用将以代码 `1` 退出。若希望改为抛出错误,请禁用 `abortOnError` 选项(例如, `NestFactory.create(AppModule, { abortOnError: false })` )。
267267
268268
#### 平台
269269

docs/recipes/cqrs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export class KillDragonCommand extends Command<{
7777
}
7878
```
7979

80-
如你所见,`KillDragonCommand` 类继承自 `Command` 类。`Command` 是从 `@nestjs/cqrs` 包导出的简单工具类,可用于定义命令的返回类型。本例中返回类型是一个包含 `actionId` 属性的对象。现在每当 `KillDragonCommand` 命令被派发时,`CommandBus#execute()` 方法的返回类型将被推断为 `Promise<{{ '{' }} actionId: string {{ '}' }}>` 。这在需要从命令处理器返回数据时非常有用。
80+
如你所见,`KillDragonCommand` 类继承自 `Command` 类。`Command` 是从 `@nestjs/cqrs` 包导出的简单工具类,可用于定义命令的返回类型。本例中返回类型是一个包含 `actionId` 属性的对象。现在每当 `KillDragonCommand` 命令被派发时,`CommandBus#execute()` 方法的返回类型将被推断为 `Promise<{ actionId: string }>` 。这在需要从命令处理器返回数据时非常有用。
8181

8282
> info **提示** 继承 `Command` 类是可选的,仅当需要定义命令返回类型时才必须使用。
8383

0 commit comments

Comments
 (0)