UNPKG

2.87 kBMarkdownView Raw
1### Mock.tpl(input, options, helpers, partials)
2
3* Mock.tpl(input)
4* Mock.tpl(input, options)
5* Mock.tpl(input, options, helpers)
6* Mock.tpl(input, options, helpers, partials)
7
8基于 Handlebars、Mustache 的 HTML 模板生成模拟数据。
9
10**参数的含义和默认值**如下所示:
11
12* **参数 input**:必选。可以是 HTML 模板,或者经过 Handlebars 解析的语法树(`Handlebars.parse(input)`)。将基于该参数生成模拟数据。
13* **参数 options**:可选。对象。称为“数据模板”,用于配置生成模拟数据的规则。例如 `{ 'email': '@EMAIL' }`,在生成模拟数据时,所有 `email` 属性对应的值将是一个邮件地址。
14* **参数 helpers**:可选。对象。表示局部 helper。全局 helper 会自动从 `Handlebars.helpers` 中读取。
15* **参数 partials**:可选。对象。表示局部子模板。全局子模板会自动从 `Handlebars.partials` 中读取。
16
17**使用示例**如下所示:
18
19 // 基于 HTML 模板生成模拟数据
20 Mock.tpl('this is {{title}}!')
21 // => {title: "title"}
22
23 // 基于 HTML 模板和数据模板生成模拟数据
24 Mock.tpl('this is {{title}}!', {
25 title: '@TITLE'
26 })
27 // => {title: "Guhwbgehq Isuzssx Ywvwt Dkp"}
28
29 // 基于 HTML 模板生成模拟数据,传入了局部命令。
30 Mock.tpl('this is {{title}}!', {}, {
31 title: function(){
32 return 'my title'
33 }
34 })
35 // => {title: "title"}
36
37 // 基于 HTML 模板生成模拟数据,传入了局部子模板。
38 Mock.tpl('{{> "sub-tpl"}}', {}, {}, {
39 'sub-tpl': '{{title}}'
40 })
41 // => {title: "title"}
42
43数据模板 `options` 可以在调用 Mock.tpl(input, options, helpers, partials) 时传入,也可以在 HTML 模板中通过 HTML 注释配置(为了避免侵入现有的代码和开发模式),格式为 `<!-- Mock {} -->` 。下面的 2 个示例演示了通过 HTML 注释配置数据模板的两种方式:集中配置、分散配置。
44
45**示例1:**在 HTML 模板中通过一个 HTML 注释**集中**配置数据模板。
46
47 var tpl = Mock.heredoc(function() {
48 /*!
49 {{email}}{{age}}
50 <!-- Mock {
51 email: '@EMAIL',
52 age: '@INT(1,100)'
53 } -->
54 */
55 })
56 var data = Mock.tpl(tpl)
57 console.log(JSON.stringify(data, null, 4))
58 // =>
59 {
60 "email": "t.lee@clark.net",
61 "age": 33
62 }
63
64**示例2:**在 HTML 模板中通过多个 HTML 注释**分散**配置数据模板。
65
66 var tpl = Mock.heredoc(function() {
67 /*!
68 {{email}}{{age}}
69 <!-- Mock {
70 email: '@EMAIL'
71 } -->
72 <!-- Mock { age: '@INT(1,100)' } -->
73 */
74 })
75 var data = Mock.tpl(tpl)
76 console.log(JSON.stringify(data, null, 4))
77 // =>
78 {
79 "email": "j.walker@brown.edu",
80 "age": 83
81 }