Skip to content

Latest commit

 

History

History
102 lines (64 loc) · 2 KB

README.md

File metadata and controls

102 lines (64 loc) · 2 KB

TPLV

Nano(~170 bytes), High performance string template library, based on ES6 String template syntax.

npm Version Build Status Coverage Status npm License

Install

$ npm i --save tplv

Usage

  • render template string
import { render } from 'tplv';

const template = '${ name }, ${value}(${percent} | Top ${array[2]})';

const data = {
  name: 'Hangzhou',
  value: 1200,
  percent: '13%',
  array: [1, 2, 3, 4]
};

render(template, data); // `Hangzhou, 1200(13% | Top 3)` will be got
  • compile mode

For 13x faster performance then render mode.

import { compile } from 'tplv';

const template = '${ name }, ${value}(${percent} | Top ${array[2]})';

const data = {
  name: 'Hangzhou',
  value: 1200,
  percent: '13%',
  array: [1, 2, 3, 4]
};

const fn = compile(template, ['name', 'value', 'percent', 'array']);

fn(data); // `Hangzhou, 1200(13% | Top 3)` will be got

Perf

Run performance test with rendering-test.

perf test

Principle

The core code and principles are as follows:

function render(template, data) {
  const ks = Object.keys(data);
  const vs = ks.map((k) => data[k]);

  const t = `return \`${template}\``;
  const f = new Function(...ks, t);

  return f(...vs);
}

Dev

# install dependence
$ npm install

# run test cases
$ npm run test

# run performance for render / compile mode
$ npm run perf

# build package
$ npm run build

License

MIT@hustcc.