koa-render-view
Koa2 template render middleware
Installation
$ npm install --save koa-render-view
Examples
Basic usage
const views = ;const path = ; app;app;
React server side rendering example
$ npm install --save react react-dom babel-preset-react
test.jsx
const React = ; Component { return <p> thispropsmessage </p> ; } moduleexports = Test;
app;app;
Parameters usage
app;app;
Aliases usage
const views = ;const data = message: "Hello world"; app;app; app;
Multiple view folders
If folders "views" and "views1" contain the same file, will be conflict and render any from the same file. For example:
const views = ;const path = ; /* views -index.html views1 -index.html*/ app;app;
In this case midleware renders first index.html in its file list. To decide this you need to write part of path
await ;// render index.html from views await ;// render index.html from views1
API
views( {(string|string[])}, parameters )
consolidate]
[parameters.engine=Template engine. Custom engine example:
const engine = { return "..."; } app
[parameters.cache=true]
If cache true builds list of files when you create view middleware
fs; app app;
But in this case, it doesn`t work, you need to set cache: false
app app;
[parameters.extension="html"]
Default file extension, if extension === "html",then render("index") equals render("index.html")
[parameters.recursive=false]
Recursive read directory
[parameters.map={}]
It is map extenstion to render engine
app
[parameters.aliases=[]]
You can create alias for path to your views
- alias - must be a string starts from @,#,!,$,_ symbols and doesn`t contain symbols /\.
- path - absolute path to directory
app; await ; //render views/index.htmlawait ; //render viewXXX/index.htmlawait ; //render viewXXX/deep/index.html
[parameters.options={}]
Render options field, these options will pass to render engine as parameters
License
MIT License
Copyright (c) 2017 Artem Shtepenko
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.