Skip to content

Commit 906a2c0

Browse files
authored
translate api.md (vuejs#149)
* Translate api.md via GitLocalize * Translate api.md via GitLocalize * Translate api.md via GitLocalize
1 parent adf161c commit 906a2c0

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

ja/api.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,27 @@ const renderer = createBundleRenderer(serverBundle, { ... })
3030

3131
## `クラス: Renderer`
3232

33-
- #### `renderer.renderToString(vm[, context], callback)`
33+
- #### `renderer.renderToString(vm[, context, callback]): ?Promise<string>`
3434

3535
Vue インスタンスを文字列として描画します。context オブジェクトの指定は、任意です。callback は、第1引数にエラー内容、 第2引数に描画された文字列を受け取る、典型的な Node.js のコーディングスタイルである関数を指定します。
3636

37-
- #### `renderer.renderToStream(vm[, context])`
37+
2.5.0 以降においては、コールバックはオプションです。コールバックなしで渡されるとき、HTML に描画されるのを解決するプロミスを返します。
3838

39-
Vue インスタンスを Node.js のストリームへ描画します。context オブジェクトの指定は任意です。より詳しい情報は、[ストリーミング](./streaming.md) の項目を参照してください。
39+
- #### `renderer.renderToStream(vm[, context]): stream.Readable`
40+
41+
Vue インスタンスを [Node.js の読み取り可能なストリーム](https://nodejs.org/dist/latest-v8.x/docs/api/stream.html#stream_readable_streams) に描画します。より詳細については、[ストリーミング](./streaming.md) を参照してください。
4042

4143
## `クラス: BundleRenderer`
4244

43-
- #### `bundleRenderer.renderToString([context, ]callback)`
45+
- #### `bundleRenderer.renderToString([context, callback]): ?Promise<string>`
4446

4547
サーババンドルを文字列として描画します。context オブジェクトの指定は、任意です。callback は、第1引数にエラー内容、 第2引数に描画された文字列を受け取る、典型的な Node.js のコーディングスタイルである関数を指定します。
4648

47-
- #### `bundleRenderer.renderToStream([context])`
49+
2.5.0 以降においては、コールバックは任意です。コールバックなしで渡されたとき、そのメソッドは描画された HTML に解決するプロミスを返します。
50+
51+
- #### `bundleRenderer.renderToStream([context]): stream.Readable`
4852

49-
サーババンドルを Node.js のストリームへ描画します。context オブジェクトの指定は任意です。より詳しい情報は、[ストリーミング](./streaming.md) の項目を参照してください
53+
バンドルを [Node.js の読み取り可能なストリーム](https://nodejs.org/dist/latest-v8.x/docs/api/stream.html#stream_readable_streams)に描画します。コンテキストオブジェクトはオプションです。より詳細は [ストリーミング](./streaming.md)を参照してください
5054

5155
## レンダラオプション
5256

@@ -67,6 +71,8 @@ const renderer = createBundleRenderer(serverBundle, { ... })
6771

6872
- `context.state`: (Object) `window.__INITIAL_STATE__` としてページ内にインライン展開されるべき Vuex のストアの初期状態を指定します。このインライン JSON は自動でクロスサイトスプリクティングを防ぐ [シリアライズされた javascript](https://github.com/yahoo/serialize-javascript) へサニタイズされます。
6973

74+
2.5.0 以降においては、埋め込みスクリプトはプロダクションモードで自動的に削除されます。
75+
7076
加えて、`clientManifest` も渡された場合、テンプレートは自動で以下を挿入します。
7177

7278
- (自動で受信される非同期のデータを含んだ)描画対象が必要とするクライアントサイドの JavaScript と CSS アセット
@@ -125,9 +131,17 @@ const renderer = createBundleRenderer(serverBundle, { ... })
125131
})
126132
```
127133

134+
- #### `shouldPrefetch`
135+
136+
- 2.5.0 以上
137+
138+
どのファイルに `<link rel="prefetch">` リソースヒントが生成されるべきかを制御する関数。
139+
140+
標準では、非同期チャンクにおける全てのアセットは、これは優先順位が低いため、プリフェッチされます。ただし、帯域幅の使用を適切に制御するために、プリフェッチするためにカスタマイズすることができます。このオプションは `shouldPreload` と同様の関数シグネチャを必要とします。
141+
128142
- #### `runInNewContext`
129143

130-
- 2.3.0以上
144+
- 2.3.0 以上
131145
- `createBundleRenderer` メソッド内でのみ使用可能
132146
- 要求事項: `boolean | 'once'` (`'once'` 2.3.1 以降でのみサポートされる)
133147

@@ -148,7 +162,7 @@ const renderer = createBundleRenderer(serverBundle, { ... })
148162

149163
- #### `basedir`
150164

151-
- 2.2.0以上
165+
- 2.2.0 以上
152166
- `createBundleRenderer` メソッド内でのみ使用可能
153167

154168
`node_modules` の依存関係を解決するために、サーババンドルのためのルートディレクトリを明示的に宣言します。 ここでは、インストール済み外部 npm 依存関係とは異なる場所に置かれた生成済みバンドルファイル、または、あなたの現在のプロジェクト内へ npm link された `vue-server-renderer` のみが必要です。

0 commit comments

Comments
 (0)