update for 2.5

Author: yyx990803

en/README.md

@@ -41,7 +41,7 @@ If you're using webpack, you can easily add prerendering with the [prerender-spa
 
 ## About This Guide
 
-This guide is focused on server-rendered Single-Page Applications using Node.js as the server. Mixing Vue SSR with other backend setups is a topic of its own and is not covered in this guide.
+This guide is focused on server-rendered Single-Page Applications using Node.js as the server. Mixing Vue SSR with other backend setups is a topic of its own and briefly discussed in a [dedicated section](./non-node.md).
 
 This guide will be very in-depth and assumes you are already familiar with Vue.js itself, and have decent working knowledge of Node.js and webpack. If you prefer a higher-level solution that provides a smooth out-of-the-box experience, you should probably give [Nuxt.js](https://nuxtjs.org/) a try. It's built upon the same Vue stack but abstracts away a lot of the boilerplate, and provides some extra features such as static site generation. However, it may not suit your use case if you need more direct control of your app's structure. Regardless, it would still be beneficial to read through this guide to better understand how things work together.
 

en/SUMMARY.md

@@ -10,6 +10,7 @@
 - [Head Management](head.md)
 - [Caching](caching.md)
 - [Streaming](streaming.md)
+- [Usage in non-Node.js Environments](non-node.md)
 - [API Reference](api.md)
   - [createRenderer](api.md#createrendereroptions)
   - [createBundleRenderer](api.md#createbundlerendererbundle-options)

en/api.md

@@ -30,23 +30,27 @@ See [Introducing the Server Bundle](./bundle-renderer.md) and [Build Configurati
 
 ## `Class: Renderer`
 
-- #### `renderer.renderToString(vm[, context], callback)`
+- #### `renderer.renderToString(vm[, context, callback]): ?Promise<string>`
 
   Render a Vue instance to string. The context object is optional. The callback is a typical Node.js style callback where the first argument is the error and the second argument is the rendered string.
 
-- #### `renderer.renderToStream(vm[, context])`
+  In 2.5.0+, the callback is also optional. When no callback is passed, the method returns a Promise which resolves to the rendered HTML.
 
-  Render a Vue instance to a Node.js stream. The context object is optional. See [Streaming](./streaming.md) for more details.
+- #### `renderer.renderToStream(vm[, context]): stream.Readable`
+
+  Render a Vue instance to a [Node.js readble stream](https://nodejs.org/dist/latest-v8.x/docs/api/stream.html#stream_readable_streams). The context object is optional. See [Streaming](./streaming.md) for more details.
 
 ## `Class: BundleRenderer`
 
-- #### `bundleRenderer.renderToString([context, ]callback)`
+- #### `bundleRenderer.renderToString([context, callback]): ?Promise<string>`
 
   Render the bundle to a string. The context object is optional. The callback is a typical Node.js style callback where the first argument is the error and the second argument is the rendered string.
 
-- #### `bundleRenderer.renderToStream([context])`
+  In 2.5.0+, the callback is also optional. When no callback is passed, the method returns a Promise which resolves to the rendered HTML.
+
+- #### `bundleRenderer.renderToStream([context]): stream.Readable`
 
-  Render the bundle to a Node.js stream. The context object is optional. See [Streaming](./streaming.md) for more details.
+  Render the bundle to a [Node.js readble stream](https://nodejs.org/dist/latest-v8.x/docs/api/stream.html#stream_readable_streams). The context object is optional. See [Streaming](./streaming.md) for more details.
 
 ## Renderer Options
 
@@ -67,6 +71,8 @@ See [Introducing the Server Bundle](./bundle-renderer.md) and [Build Configurati
 
   - `context.state`: (Object) initial Vuex store state that should be inlined in the page as `window.__INITIAL_STATE__`. The inlined JSON is automatically sanitized with [serialize-javascript](https://github.com/yahoo/serialize-javascript) to prevent XSS.
 
+    In 2.5.0+, the embed script also self-removes in production mode.
+
   In addition, when `clientManifest` is also provided, the template automatically injects the following:
 
   - Client-side JavaScript and CSS assets needed by the render (with async chunks automatically inferred);
@@ -125,6 +131,14 @@ See [Introducing the Server Bundle](./bundle-renderer.md) and [Build Configurati
   })
   ```
 
+- #### `shouldPrefetch`
+
+  - 2.5.0+
+
+  A function to control what files should have `<link rel="prefetch">` resource hints generated.
+
+  By default, all assets in async chunks will be prefetched since this is a low-priority directive; however you can customize what to prefetch in order to better control bandwidth usage. This option expects the same function signature as `shouldPreload`.
+
 - #### `runInNewContext`
 
   - 2.3.0+

en/basic.md

@@ -32,6 +32,13 @@ renderer.renderToString(app, (err, html) => {
   console.log(html)
   // => <div data-server-rendered="true">Hello World</div>
 })
+
+// in 2.5.0+, returns a Promise if no callback is passed:
+renderer.renderToString.then(html => {
+  console.log(html)
+}).catch(err => {
+  console.error(err)
+})
 ```
 
 ## Integrating with a Server
@@ -112,7 +119,7 @@ The template also supports simple interpolation. Given the following template:
   <head>
     <!-- use double mustache for HTML-escaped interpolation -->
     <title>{{ title }}</title>
-    
+
     <!-- use triple mustache for non-HTML-escaped interpolation -->
     {{{ meta }}}
   </head>

en/non-node.md

@@ -0,0 +1,41 @@
+# Usage in non-Node.js Environments
+
+The default build of `vue-server-renderer` assumes a Node.js environment, which makes it unusable in alternative JavaScript environments such as [php-v8js](https://github.com/phpv8/v8js) or [Nashorn](https://docs.oracle.com/javase/8/docs/technotes/guides/scripting/nashorn/). In 2.5 we have shipped a build in `vue-server-renderer/basic.js` that is largely environment-agnostic, which makes it usable in the environments mentioned above.
+
+For both environments, it is necessary to first prepare the environment by mocking the `global` and `process` objects, with `process.env.VUE_ENV` set to `"server"`, and `process.env.NODE_ENV` set to `"development"` or `"production"`.
+
+In Nashorn, it may also be necessary to provide a polyfill for `Promise` or `setTimeout` using Java's native timers.
+
+Example usage in php-v8js:
+
+``` php
+<?php
+$vue_source = file_get_contents('/path/to/vue.js');
+$renderer_source = file_get_contents('/path/to/vue-server-renderer/basic.js');
+$app_source = file_get_contents('/path/to/app.js');
+
+$v8 = new V8Js();
+
+$v8->executeString('var process = { env: { VUE_ENV: "server", NODE_ENV: "production" }}; this.global = { process: process };');
+$v8->executeString($vue_source);
+$v8->executeString($renderer_source);
+$v8->executeString($app_source);
+?>
+```
+
+---
+
+``` js
+// app.js
+var vm = new Vue({
+  template: `<div>{{ msg }}</div>`,
+  data: {
+    msg: 'hello'
+  }
+})
+
+// exposed by vue-server-renderer/basic.js
+renderVueComponentToString(vm, (err, res) => {
+  print(res)
+})
+```