Logo for jsDocs.io

vue-server-renderer

  • Version 2.7.16
  • Published
  • 748 kB
  • 8 dependencies
  • MIT license

Install

npm i vue-server-renderer
yarn add vue-server-renderer
pnpm add vue-server-renderer

Overview

server renderer for Vue 2.0

Index

Functions

Interfaces

Type Aliases

Functions

function createBundleRenderer

createBundleRenderer: (
    bundle: string | object,
    options?: BundleRendererOptions
) => BundleRenderer;

    function createRenderer

    createRenderer: (options?: RendererOptions) => Renderer;

      Interfaces

      interface BundleRenderer

      interface BundleRenderer {}

        method renderToStream

        renderToStream: (context?: object) => Readable;

          method renderToString

          renderToString: {
              (callback: RenderCallback): void;
              (context: object, callback: RenderCallback): void;
              (): Promise<string>;
              (context: object): Promise<string>;
          };

            interface BundleRendererOptions

            interface BundleRendererOptions extends RendererOptions {}

              property basedir

              basedir?: string;

                property clientManifest

                clientManifest?: object;

                  property runInNewContext

                  runInNewContext?: boolean | 'once';

                    property serializer

                    serializer?: (state: object) => string;

                      interface RenderCache

                      interface RenderCache {}

                        property get

                        get: (key: string, cb?: (res: string) => void) => string | void;

                          property has

                          has?: (key: string, cb?: (hit: boolean) => void) => boolean | void;

                            property set

                            set: (key: string, val: string) => void;

                              interface Renderer

                              interface Renderer {}

                                method renderToStream

                                renderToStream: (vm: Vue, context?: object) => Readable;

                                  method renderToString

                                  renderToString: {
                                      (vm: Vue, callback: RenderCallback): void;
                                      (vm: Vue, context: object, callback: RenderCallback): void;
                                      (vm: Vue): Promise<string>;
                                      (vm: Vue, context: object): Promise<string>;
                                  };

                                    interface RendererOptions

                                    interface RendererOptions {}

                                      property cache

                                      cache?: RenderCache;

                                        property directives

                                        directives?: {
                                            [key: string]: (vnode: VNode, dir: VNodeDirective) => void;
                                        };

                                          property inject

                                          inject?: boolean;

                                            property shouldPrefetch

                                            shouldPrefetch?: (file: string, type: string) => boolean;

                                              property shouldPreload

                                              shouldPreload?: (file: string, type: string) => boolean;

                                                property template

                                                template?: string;

                                                  Type Aliases

                                                  type RenderCallback

                                                  type RenderCallback = (err: Error | null, html: string) => void;

                                                    Package Files (1)

                                                    Dependencies (8)

                                                    Dev Dependencies (5)

                                                    Peer Dependencies (0)

                                                    No peer dependencies.

                                                    Badge

                                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/vue-server-renderer.

                                                    • Markdown
                                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/vue-server-renderer)
                                                    • HTML
                                                      <a href="https://www.jsdocs.io/package/vue-server-renderer"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>