Home / Function/ createBundleRendererCreator() — vue Function Reference

createBundleRendererCreator() — vue Function Reference

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

Entity Profile

Dependency Diagram

graph TD
  14f9202e_1e3d_a247_6325_f9f31fa8ab03["createBundleRendererCreator()"]
  24d43b0f_bfa5_fdec_64f4_2ec52a85dad4["createSourceMapConsumers()"]
  14f9202e_1e3d_a247_6325_f9f31fa8ab03 -->|calls| 24d43b0f_bfa5_fdec_64f4_2ec52a85dad4
  026cfe7c_3b65_a277_dd1c_866e5ce8b6df["createRenderer()"]
  14f9202e_1e3d_a247_6325_f9f31fa8ab03 -->|calls| 026cfe7c_3b65_a277_dd1c_866e5ce8b6df
  26b57d84_121f_755e_f3cd_eb5e57e71799["createBundleRunner()"]
  14f9202e_1e3d_a247_6325_f9f31fa8ab03 -->|calls| 26b57d84_121f_755e_f3cd_eb5e57e71799
  d660e87a_fc16_39ca_ed3e_77e15eb70d30["createPromiseCallback()"]
  14f9202e_1e3d_a247_6325_f9f31fa8ab03 -->|calls| d660e87a_fc16_39ca_ed3e_77e15eb70d30
  fde87ae5_e8fa_62fd_31f4_15b1131eb7e5["rewriteErrorTrace()"]
  14f9202e_1e3d_a247_6325_f9f31fa8ab03 -->|calls| fde87ae5_e8fa_62fd_31f4_15b1131eb7e5
  style 14f9202e_1e3d_a247_6325_f9f31fa8ab03 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/server-renderer/src/bundle-renderer/create-bundle-renderer.ts lines 32–159

export function createBundleRendererCreator(
  createRenderer: (options?: RenderOptions) => Renderer
) {
  return function createBundleRenderer(
    bundle: string | RenderBundle,
    rendererOptions: RenderOptions = {}
  ) {
    let files, entry, maps
    let basedir = rendererOptions.basedir

    // load bundle if given filepath
    if (
      typeof bundle === 'string' &&
      /\.js(on)?$/.test(bundle) &&
      path.isAbsolute(bundle)
    ) {
      if (fs.existsSync(bundle)) {
        const isJSON = /\.json$/.test(bundle)
        basedir = basedir || path.dirname(bundle)
        bundle = fs.readFileSync(bundle, 'utf-8')
        if (isJSON) {
          try {
            // @ts-expect-error
            bundle = JSON.parse(bundle)
          } catch (e: any) {
            throw new Error(`Invalid JSON bundle file: ${bundle}`)
          }
        }
      } else {
        throw new Error(`Cannot locate bundle file: ${bundle}`)
      }
    }

    if (typeof bundle === 'object') {
      entry = bundle.entry
      files = bundle.files
      basedir = basedir || bundle.basedir
      maps = createSourceMapConsumers(bundle.maps)
      if (typeof entry !== 'string' || typeof files !== 'object') {
        throw new Error(INVALID_MSG)
      }
    } else if (typeof bundle === 'string') {
      entry = '__vue_ssr_bundle__'
      files = { __vue_ssr_bundle__: bundle }
      maps = {}
    } else {
      throw new Error(INVALID_MSG)
    }

    const renderer = createRenderer(rendererOptions)

    const run = createBundleRunner(
      entry,
      files,
      basedir,
      rendererOptions.runInNewContext
    )

    return {
      renderToString: (context?: Object | undefined, cb?: any) => {
        if (typeof context === 'function') {
          cb = context
          context = {}
        }

        let promise
        if (!cb) {
          ;({ promise, cb } = createPromiseCallback())
        }

        run(context)
          .catch(err => {
            rewriteErrorTrace(err, maps)
            cb(err)
          })
          .then(app => {
            if (app) {
              //@ts-expect-error
              renderer.renderToString(app, context, (err, res) => {
                rewriteErrorTrace(err, maps)
                cb(err, res)
              })
            }
          })

        return promise
      },

      renderToStream: (context?: Object) => {
        const res = new PassThrough()
        run(context)
          .catch(err => {
            rewriteErrorTrace(err, maps)
            // avoid emitting synchronously before user can
            // attach error listener
            process.nextTick(() => {
              res.emit('error', err)
            })
          })
          .then(app => {
            if (app) {
              //@ts-expect-error
              const renderStream = renderer.renderToStream(app, context)

              renderStream.on('error', err => {
                rewriteErrorTrace(err, maps)
                res.emit('error', err)
              })

              // relay HTMLStream special events
              if (rendererOptions && rendererOptions.template) {
                renderStream.on('beforeStart', () => {
                  res.emit('beforeStart')
                })
                renderStream.on('beforeEnd', () => {
                  res.emit('beforeEnd')
                })
              }

              renderStream.pipe(res)
            }
          })

        return res
      }
    }
  }
}

Subdomains

Frequently Asked Questions

What does createBundleRendererCreator() do?
createBundleRendererCreator() is a function in the vue codebase.
What does createBundleRendererCreator() call?
createBundleRendererCreator() calls 5 function(s): createBundleRunner, createPromiseCallback, createRenderer, createSourceMapConsumers, rewriteErrorTrace.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free