Skip to content

Latest commit

 

History

History
222 lines (159 loc) · 5.85 KB

ssr.md

File metadata and controls

222 lines (159 loc) · 5.85 KB
Raw

サーバーサイドレンダリング API {#server-side-rendering-api}

renderToString() {#rendertostring}

  • vue/server-renderer からエクスポート

  • 型

    function renderToString(
  input: App | VNode,
  context?: SSRContext
): Promise<string>

  • 例

    import { createSSRApp } from 'vue'
import { renderToString } from 'vue/server-renderer'

const app = createSSRApp({
  data: () => ({ msg: 'hello' }),
  template: `<div>{{ msg }}</div>`
})

;(async () => {
  const html = await renderToString(app)
  console.log(html)
})()

    SSR コンテキスト {#ssr-context}

    省略可能なコンテキストオブジェクトを渡すと、レンダリング中に追加データを記録するために使用できます。例えば、テレポートのコンテンツにアクセスするには:

    const ctx = {}
const html = await renderToString(app, ctx)

console.log(ctx.teleports) // { '#teleported': 'teleported content' }

    このページにある他のほとんどの SSR API も、省略可能なコンテキストオブジェクトを受け付けます。useSSRContext ヘルパーを使うことで、コンポーネントコード内でコンテキストオブジェクトにアクセスできます。

  • 参照: ガイド - サーバーサイドレンダリング

renderToNodeStream() {#rendertonodestream}

入力を Node.js Readable stream としてレンダリングします。

  • vue/server-renderer からエクスポート

  • 型

    function renderToNodeStream(
  input: App | VNode,
  context?: SSRContext
): Readable

  • 例

    // Node.js http handler の内部
renderToNodeStream(app).pipe(res)

    :::tip Note このメソッドは、Node.js 環境から切り離されている vue/server-renderer の ESM ビルドではサポートされていません。代わりに pipeToNodeWritable を使用してください。 :::

pipeToNodeWritable() {#pipetonodewritable}

既存の Node.js Writable stream インスタンスにパイプしてレンダリングします。

  • vue/server-renderer からエクスポート

  • 型

    function pipeToNodeWritable(
  input: App | VNode,
  context: SSRContext = {},
  writable: Writable
): void

  • 例

    // Node.js http handler の内部
pipeToNodeWritable(app, {}, res)

renderToWebStream() {#rendertowebstream}

入力を Web ReadableStream としてレンダリングします。

  • vue/server-renderer からエクスポート

  • 型

    function renderToWebStream(
  input: App | VNode,
  context?: SSRContext
): ReadableStream

  • 例

    // ReadableStream がサポートされている環境の内部
return new Response(renderToWebStream(app))

    :::tip Note グローバルスコープで ReadableStream コンストラクターを公開しない環境では、代わりに pipeToWebWritable() を使用する必要があります。 :::

pipeToWebWritable() {#pipetowebwritable}

既存の Web WritableStream インスタンスにパイプしてレンダリングします。

  • vue/server-renderer からエクスポート

  • 型

    function pipeToWebWritable(
  input: App | VNode,
  context: SSRContext = {},
  writable: WritableStream
): void

  • 例

    これは通常、TransformStream と組み合わせて使用されます:

    // TransformStream は、CloudFlare のワーカーなどの環境で利用できます。
// Node.js では、'stream/web' から明示的にインポートする必要があります
const { readable, writable } = new TransformStream()
pipeToWebWritable(app, {}, writable)

return new Response(readable)

renderToSimpleStream() {#rendertosimplestream}

シンプルで読みやすいインターフェイスを使用して、ストリーミングモードで入力をレンダリングします。

  • vue/server-renderer からエクスポート

  • 型

    function renderToSimpleStream(
  input: App | VNode,
  context: SSRContext,
  options: SimpleReadable
): SimpleReadable

interface SimpleReadable {
  push(content: string | null): void
  destroy(err: any): void
}

  • 例

    let res = ''

renderToSimpleStream(
  app,
  {},
  {
    push(chunk) {
      if (chunk === null) {
        // 完了
        console(`render complete: ${res}`)
      } else {
        res += chunk
      }
    },
    destroy(err) {
      // エラーが発生
    }
  }
)

useSSRContext() {#usessrcontext}

renderToString() やその他のサーバー レンダリング API に渡されるコンテキストオブジェクトを取得するために使用するランタイム API。

  • 型

    function useSSRContext<T = Record<string, any>>(): T | undefined

  • 例

    取得したコンテキストを使用して、最終的な HTML をレンダリングするために必要な情報（ヘッドメタデータなど）を添付できます。

    <script setup>
import { useSSRContext } from 'vue'

// SSR の時だけ呼び出すようにする
// https://ja.vitejs.dev/guide/ssr.html#条件付きロジック
if (import.meta.env.SSR) {
  const ctx = useSSRContext()
  // ...コンテキストにプロパティを付加する
}
</script>