中文 README

Process


How to use

``bash
npm i fast-ftl -S
`
#### Step 1 - Import
##### 1. Import in es2015+
`javascript
import Render from "fast-ftl";
`

##### 2. Require in CommonJS
`javascript
const {Render} = require("fast-ftl");
`
or
`javascript
var Render = require("fast-ftl").Render;
`

#### Step 2 - Init Fast-FTL
`javascript
var render = Render({
root: path.join(__dirname, 'pages'),
paths: [
path.join(__dirname, 'common')
], // Support MultiTemplateLoader
defaultEncoding: "utf-8", // 默认 encoding
urlEscapingCharsetSet: "utf-8", // URLEscapingCharset
numberFormat: "0.##########", // 数字格式化方式
templateUpdateDelay: 0 // milliseconds 为单位
});
`

| property | Fast-FTL | defaultValue|
| ------| ------ | ------ |
| default_encoding | defaultEncoding | utf-8 |
| url_escaping_charset | urlEscapingCharsetSet | utf-8 |
| number_format | numberFormat | 0.########## |
| template_update_delay(Milliseconds)| templateUpdateDelay | 0 |

#### Step 3 - Parse file
`javascript
render.parse("test.ftl", {
YourName: "Jack"
}).then(data => {
console.log(data);
}).catch(e => {
console.log(e)
});
``

Features

1. Fast: use Socket to invoke Java Freemarker Parser, not in Teminal.
2. Support MultiTemplate Directory.
3. Simple API, base on Promise.

Contributors

|
_君羽
💻 🔌 🚇 📖
⚠️ 🐛 💡 |
_carryxyh
💻

|
| :---: | :---: |

LICENSE

[![license][license-image]][license-url]

[npm-url]: https://npmjs.org/package/fast-ftl
[npm-image]: https://img.shields.io/npm/v/fast-ftl.svg