Gao Yingjian
f62d4fbc8d
* docs: sync Chinese doc to 3.0.0-rc.1 * docs: sync Chinese doc to 3.0.0-rc.2
49 lines
954 B
Markdown
49 lines
954 B
Markdown
# ApolloSSR
|
|
|
|
## 用法
|
|
|
|
详见 [SSR 指南](../guide/ssr.md)。
|
|
|
|
## 方法
|
|
|
|
### getStates
|
|
|
|
将 apollo store 状态作为 JavaScript 对象返回。
|
|
|
|
```js
|
|
const states = ApolloSSR.getStates(apolloProvider, options)
|
|
```
|
|
|
|
`options` 的默认值是：
|
|
|
|
```js
|
|
{
|
|
// 每个 apollo 客户端状态的 key 的前缀
|
|
exportNamespace: '',
|
|
}
|
|
```
|
|
|
|
### exportStates
|
|
|
|
将 apollo store 状态作为字符串内的 JavaScript 代码返回。该代码可以直接注入到页面 HTML 的 `<script>` 标签中。
|
|
|
|
```js
|
|
const js = ApolloSSR.exportStates(apolloProvider, options)
|
|
```
|
|
|
|
`options` 的默认值是：
|
|
|
|
```js
|
|
{
|
|
// 全局变量名
|
|
globalName: '__APOLLO_STATE__',
|
|
// 变量设置到的全局对象
|
|
attachTo: 'window',
|
|
// 每个 apollo 客户端状态的 key 的前缀
|
|
exportNamespace: '',
|
|
// 我们默认使用 sanitize js 库来阻止 XSS
|
|
// 在这里传入 true 将对状态执行标准的 JSON.stringify
|
|
useUnsafeSerializer: false,
|
|
}
|
|
```
|