createRenderer() — vue Function Reference

Architecture documentation for the createRenderer() function in create-renderer.ts from the vue codebase.

Function typescript ServerRenderer BundleRenderer calls 6 called by 2

Entity Profile

ServerRenderer→ BundleRenderer→ createRenderer() — vue Function Reference

Dependency Diagram

graph TD
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df["createRenderer()"]
  14f9202e_1e3d_a247_6325_f9f31fa8ab03["createBundleRendererCreator()"]
  14f9202e_1e3d_a247_6325_f9f31fa8ab03 -->|calls| 026cfe7c_3b65_a277_dd1c_866e5ce8b6df
  a9e6842c_239d_32cc_a243_bf732803670a["createRenderer()"]
  a9e6842c_239d_32cc_a243_bf732803670a -->|calls| 026cfe7c_3b65_a277_dd1c_866e5ce8b6df
  4c21c903_0357_dce5_cb90_83c67295a504["createRenderFunction()"]
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df -->|calls| 4c21c903_0357_dce5_cb90_83c67295a504
  47eb75e1_de2a_7bc3_18eb_bb890408789d["bindRenderFns()"]
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df -->|calls| 47eb75e1_de2a_7bc3_18eb_bb890408789d
  d660e87a_fc16_39ca_ed3e_77e15eb70d30["createPromiseCallback()"]
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df -->|calls| d660e87a_fc16_39ca_ed3e_77e15eb70d30
  06fee7d4_f38c_cb80_f7c8_47dea21e6cb4["createWriteFunction()"]
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df -->|calls| 06fee7d4_f38c_cb80_f7c8_47dea21e6cb4
  31cd301c_a88b_c811_2866_b3d6f4b7a004["render()"]
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df -->|calls| 31cd301c_a88b_c811_2866_b3d6f4b7a004
  919be3ec_c099_16a6_f47e_621c3e1086af["createStream()"]
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df -->|calls| 919be3ec_c099_16a6_f47e_621c3e1086af
  style 026cfe7c_3b65_a277_dd1c_866e5ce8b6df fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/server-renderer/src/create-renderer.ts lines 43–164

export function createRenderer({
  modules = [],
  directives = {},
  isUnaryTag = () => false,
  template,
  inject,
  cache,
  shouldPreload,
  shouldPrefetch,
  clientManifest,
  serializer
}: RenderOptions = {}): Renderer {
  const render = createRenderFunction(modules, directives, isUnaryTag, cache)
  const templateRenderer = new TemplateRenderer({
    template,
    inject,
    // @ts-expect-error
    shouldPreload,
    // @ts-expect-error
    shouldPrefetch,
    clientManifest,
    serializer
  })

  return {
    renderToString(
      component: Component,
      context?: any,
      cb?: any
    ): Promise<string> {
      if (typeof context === 'function') {
        cb = context
        context = {}
      }
      if (context) {
        templateRenderer.bindRenderFns(context)
      }

      // no callback, return Promise
      let promise
      if (!cb) {
        ;({ promise, cb } = createPromiseCallback())
      }

      let result = ''
      const write = createWriteFunction(text => {
        result += text
        return false
      }, cb)
      try {
        // @ts-expect-error TODO improve
        render(component, write, context, err => {
          if (err) {
            return cb(err)
          }
          if (context && context.rendered) {
            context.rendered(context)
          }
          if (template) {
            try {
              const res = templateRenderer.render(result, context)
              if (typeof res !== 'string') {
                // function template returning promise
                res.then(html => cb(null, html)).catch(cb)
              } else {
                cb(null, res)
              }
            } catch (e: any) {
              cb(e)
            }
          } else {
            cb(null, result)
          }
        })
      } catch (e: any) {
        cb(e)
      }

      return promise
    },

    renderToStream(component: Component, context?: Object): Readable {
      if (context) {
        templateRenderer.bindRenderFns(context)
      }
      const renderStream = new RenderStream((write, done) => {
        // @ts-expect-error
        render(component, write, context, done)
      })
      if (!template) {
        // @ts-expect-error
        if (context && context.rendered) {
          // @ts-expect-error
          const rendered = context.rendered
          renderStream.once('beforeEnd', () => {
            rendered(context)
          })
        }
        return renderStream
      } else if (typeof template === 'function') {
        throw new Error(
          `function template is only supported in renderToString.`
        )
      } else {
        const templateStream = templateRenderer.createStream(context)
        renderStream.on('error', err => {
          templateStream.emit('error', err)
        })
        renderStream.pipe(templateStream)
        //@ts-expect-error
        if (context && context.rendered) {
          //@ts-expect-error
          const rendered = context.rendered
          renderStream.once('beforeEnd', () => {
            rendered(context)
          })
        }
        return templateStream
      }
    }
  }
}