fary-vue-ssr
TypeScript icon, indicating that this package has built-in type declarations

0.1.1 • Public • Published

fary-vue-ssr

这是一个用来处理vue服务端渲染的Koa中间件

Usage

安装:

npm i fary-vue-ssr -S

使用:

const Koa = require('koa')
const faryVueSSR = require('fary-vue-ssr')
 
const app = new Koa()
app.use(faryVueSSR(options))

options

ssr: boolean

是否启用服务端渲染

serverBundle: object | function

vue-server-renderer中使用的模块,可以在webpack中使用vue-ssr-webpack-plugin生成。

该参数还可以传入一个方法,返回一个Promise,Promise中resolve需要使用的bundle信息

clientManifest: object | function

vue-server-renderer配置中对应的clientManifest内容,可以由vue-server-renderer/client-plugin生成。

该参数还可以传入一个方法,返回一个Promise,Promise中resolve需要使用的manifest信息

template: string | function

渲染内容时用到的模板文件,中间件使用ejs进行渲染,渲染参数如下:

{
  style: string, // 行内样式
  scripts: string, // 客户端javascripts,需要clientManifest
  title: string, // 从路由配置的meta中读取
  meta: object, // 路由配置的meta
  appString: string, // 服务端渲染的html内容
  initialState: object, // store的state
  initialLocalState: object, // 使用的localData
  preLoadAndFetch: string, // 预加载的静态文件,需要clientManifest
}

exclude: RegExp

不需要使用服务端渲染的路由

cache: boolean | object | function

如果为true,使用LRU缓存,object和function则为自定义的缓存配置

runInNewContext: boolean

是否每次都在新的执行环境执行,为true较为消耗性能,如果能保证js代码不会修改global内容,可以选择设置为false

directives: object

请参考这里

Readme

Keywords

Package Sidebar

Install

npm i fary-vue-ssr

Weekly Downloads

0

Version

0.1.1

License

MIT

Last publish

Collaborators

  • jokcy