![\"Ts.ED](\"https://tsed.devtsed-og.png\")
\n\n \n
<%= user.name %>
\")\n .then((html) => {\n console.log(html);\n });\n```\n\n## Caching\n\nTo enable caching simply pass `{ cache: true }`. EnginesContainer _may_ use this option to cache things reading the file contents, compiled `Function`s etc.\nEnginesContainer which do _not_ support this may simply ignore it. All engines that consolidate.js implements I/O for will cache the file contents, ideal for production environments.\nWhen using @tsed/engines directly: `getEngine('swig').renderFile('views/page.html', { user: 'tobi', cache: true });`\n\nUsing supported Express versions: `app.locals.cache = true` or set NODE_ENV to 'production' and Express will do this for you.\n\n## Express example\n\n`@tsed/engines` can be used with Express as following:\n\n```typescript\nimport express from \"express\";\nimport {getEngine} from \"@tsed/engines\";\nimport \"@tsed/engines/SwigEngine.js\"; // or any other engine you want to use\n\n// assign the swig engine to .html files\napp.engine(\"html\", getEngine(\"swig\"));\n\n// set .html as the default extension\napp.set(\"view engine\", \"html\");\napp.set(\"views\", __dirname + \"/views\");\n\nvar users = [];\nusers.push({name: \"tobi\"});\nusers.push({name: \"loki\"});\nusers.push({name: \"jane\"});\n\napp.get(\"/\", function (req, res) {\n res.render(\"index\", {\n title: \"Ts.ED EnginesContainer\"\n });\n});\n\napp.get(\"/users\", function (req, res) {\n res.render(\"users\", {\n title: \"Users\",\n users: users\n });\n});\n\napp.listen(3000);\nconsole.log(\"Express server listening on port 3000\");\n```\n\n## Koa\n\n`@tsed/engines` can be used with Koa as following:\n\n```typescript\nimport {getEngines} from \"./getEngines.js\";\nimport \"@tsed/engines/SwigEngine.js\"; // or any other engine you want to use\n\nvar views = require(\"koa-views\");\n\nconst render = views(__dirname + \"/views\", {\n engineSource: getEngines(),\n map: {\n html: \"underscore\"\n }\n});\n\n// Must be used before any router is used\napp.use(render);\n// OR Expand by app.context\n// No order restrictions\n// app.context.render = render()\n\napp.use(async function (ctx) {\n ctx.state = {\n session: this.session,\n title: \"app\"\n };\n\n await ctx.render(\"user\", {\n user: \"John\"\n });\n});\n```\n\n## Template Engine Instances\n\nTemplate engines are exposed via the `requires` object, but they are not instantiated until you've called the `getEngine(engine).render()` method.\nYou can instantiate them manually beforehand if you want to add filters, globals, mixins, or other engine features.\n\n```typescript\nimport {requires} from \"@tsed/engines\";\nimport \"@tsed/engines/NunjucksEngine.js\"; // or any other engine you want to use\n\nimport nunjucks from \"nunjucks\";\n\n// add nunjucks to requires so filters can be\n// added and the same instance will be used inside the render method\nrequires.set(\"nunjucks\", nunjucks.configure());\n\nrequires.get(\"nunjucks\").addFilter(\"foo\", () => {\n return \"bar\";\n});\n```\n\n## Implement your own engine\n\n`@tsed/engines` let you register your own engine by using the `@ViewEngine` decorator. Here an is example of\npug engine implementation:\n\n```typescript\nimport {Engine, ViewEngine} from \"@tsed/engines\";\nimport \"@tsed/engines/PugEngine.js\"; // or any other engine you want to use\n\n@ViewEngine(\"pug\", {\n requires: [\"pug\", \"then-pug\"] // multiple require is possible. Ts.ED will use the first module resolved from node_modules\n})\nexport class PugEngine extends Engine {\n protected $compile(template: string, options: any) {\n return this.engine.compile(template, options);\n }\n\n protected async $compileFile(file: string, options: any) {\n return this.engine.compileFile(file, options);\n }\n}\n```\n\nSee more examples in `packages/engines/src/components` directory.\n\n## Override engine\n\n```typescript\nimport {PugEngine} from \"@tsed/engines\";\nimport \"@tsed/engines/PugEngine.js\"; // or any other engine you want to use\n\n@ViewEngine(\"pug\", {\n requires: [\"pug\", \"then-pug\"] // multiple require is possible. Ts.ED will use the first module resolved from node_modules\n})\nexport class CustomePugEngine extends PugEngine {\n protected $compile(template: string, options: any) {\n return super.$compile(template, options);\n }\n\n protected async $compileFile(file: string, options: any) {\n return super.$compileFile(file, options);\n }\n}\n```\n\n## Notes\n\n- If you're using Nunjucks, please take a look at the `exports.nunjucks.render` function in `packages/engines/src/components/NunjuncksEngine.ts`. You can pass your own engine/environment via `options.nunjucksEnv`, or if you want to support Express you can pass `options.settings.views`, or if you have another use case, pass `options.nunjucks` (see the code for more insight).\n- You can pass **partials** with `options.partials`\n- For using **template inheritance** with nunjucks, you can pass a loader\n with `options.loader`.\n- `React` To render content into a html base template (eg. `index.html` of your React app), pass the path of the template with `options.base`.\n\n## Contributors\n\nPlease read [contributing guidelines here](https://tsed.devcontributing.html)\n\n![](\"https://opencollective.com/tsed/contributors.svg?width=890\")
\n\n## Backers\n\nThank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]\n\n![](\"https://opencollective.com/tsed/tiers/backer.svg?width=890\")
\n\n## Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2016 - Today Romain Lenzotti\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n","readmeFilename":"readme.md"}