Skip to content

Commit 324dd65

Browse files
Merge pull request vuejs#115 from dear-lizhihua/gitlocalize-217
update zh/api.md
2 parents 11640f4 + 1627661 commit 324dd65

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

zh/api.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ const renderer = createBundleRenderer(serverBundle, { ... })
2121
`serverBundle` 参数可以是以下之一:
2222

2323
- 绝对路径,指向一个已经构建好的 bundle 文件(`.js``.json`)。必须以 `/` 开头才会被识别为文件路径。
24+
2425
- 由 webpack + `vue-server-renderer/server-plugin` 生成的 bundle 对象。
26+
2527
- JavaScript 代码字符串(不推荐)。
2628

2729
更多细节请查看 [Server Bundle 指引](./bundle-renderer.md)[构建配置](./build-config.md)
@@ -60,7 +62,9 @@ const renderer = createBundleRenderer(serverBundle, { ... })
6062
当在渲染上下文 (render context) 上存在一些特定属性时,模板会自动注入对应的内容:
6163

6264
- `context.head`:(字符串)将会被作为 HTML 注入到页面的头部 (head) 里。
65+
6366
- `context.styles`:(字符串)内联 CSS,将以 style 标签的形式注入到页面头部。注意,如过你使用了 `vue-loader` + `vue-style-loader` 来处理组件 CSS,此属性会在构建过程中被自动生成。
67+
6468
- `context.state`:(对象)初始 Vuex store 状态,将以 `window.__INITIAL_STATE__` 的形式内联到页面。内联的 JSON 将使用 [serialize-javascript](https://github.com/yahoo/serialize-javascript) 自动清理,以防止 XSS 攻击。
6569

6670
此外,当提供 `clientManifest` 时,模板会自动注入以下内容:
@@ -73,8 +77,10 @@ const renderer = createBundleRenderer(serverBundle, { ... })
7377
具体查看:
7478

7579
- [使用一个页面模板](./basic.md#using-a-page-template)
80+
7681
- [手动资源注入(Manual Asset Injection)](./build-config.md#manual-asset-injection)
7782
- #### `clientManifest`
83+
7884
- 2.3.0+
7985

8086
通过此选项提供一个由 `vue-server-renderer/client-plugin` 生成的客户端构建 manifest 对象 (client build manifest object)。此对象包含了 webpack 整个构建过程的信息,从而可以让 bundle renderer 自动推导需要在 HTML 模板中注入的内容。更多详细信息,请查看[生成 clientManifest](./build-config.md#generating-clientmanifest)
@@ -149,7 +155,7 @@ const renderer = createBundleRenderer(serverBundle, { ... })
149155
- 2.2.0+
150156
- 只用于 `createBundleRenderer`
151157

152-
显式地声明 server bundle 的运行目录。运行时将会以此目录为基准来解析 `node_modules` 中的依赖模块。只有在所生成的 bundle 文件与外部的 NPM 依赖模块放置在不同位置,或者 `vue-server-renderer` 是通过 npm link 链接到当前项目中时,才需要配置此选项。
158+
显式地声明 server bundle 的运行目录。运行时将会以此目录为基准来解析 `node_modules` 中的依赖模块。只有在所生成的 bundle 文件与外部的 NPM 依赖模块放置在不同位置,或者 `vue-server-renderer` 是通过 NPM link 链接到当前项目中时,才需要配置此选项。
153159

154160
- #### `cache`
155161

@@ -174,7 +180,7 @@ const renderer = createBundleRenderer(serverBundle, { ... })
174180
})
175181
```
176182

177-
请注意,缓存对象应至少要实现 `get``set`。此外,如果 `get``has` 接收第二个参数作为回调,那 <code>get</code> 和 <code>has</code> 也可以是可选的异步函数。这允许缓存使用异步 API,例如,一个 redis 客户端:
183+
请注意,缓存对象应至少要实现 `get``set`。此外,如果 `get``has` 接收第二个参数作为回调,那 <code>get</code> 和 <code>has</code> 也可以是可选的异步函数。这允许缓存使用异步 API,例如,一个 Redis 客户端:
178184

179185
```js
180186
const renderer = createRenderer({

0 commit comments

Comments
 (0)