https://github.com/yangfuhai/fasty

a faster javascript templating engine.
https://github.com/yangfuhai/fasty

Last synced: 3 days ago
JSON representation

a faster javascript templating engine.

• Host: GitHub
• URL: https://github.com/yangfuhai/fasty
• Owner: yangfuhai
• License: mit
• Created: 2022-05-25T10:44:04.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-12T03:29:28.000Z (over 2 years ago)
• Last Synced: 2024-11-20T19:40:57.772Z (2 months ago)
• Language: JavaScript
• Size: 240 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.txt
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fasty -  a faster javascript templating engine.

[中文文档](./readme_cn.md)

Fasty is a simple and super fast templating engine that 

use a template rendering speed by a special cache solution, 

hence achieving runtime performance which is close to the limits of JavaScript. 

At the same time, it supports both NodeJS and browser.

>Fasty Rendering faster is 100+ times more than other JavaScript engines.

## Usage

**Usage 1**

```javascript

var template = '
 hello {{ name }} 
'

var data = {name: "fasty"}


var fasty = new Fasty();

var result = fasty.render(template,data);

// result: 
 hello fasty 

```


**Usage 2**

```javascript

var template = ' {{attr}} hello {{ func1(name) }}'

var data = {name: "fasty"}

var fasty = new Fasty({

    //the shared template data or functions

    share : {

        attr:'text...',

        func1:function (v){

            return v + " kiss~~"

        },

    }

});

var result = fasty.render(template,data);

// result: text... hello fasty kiss~~

```

## Fasty grammar

### output

```

// #1 Variable

{{~ var x = 100}}

{{x}}

//output: 100

// #2 string

{{"hello world"}}

//output: hello world

// #3

{{1+2+3}}

//output:6

{{100 / 100}}

//output:1

{{10%3 * 100}}

//output:100

// #4 escape

{{! "
 hello world 
"}}

//output: <div> hello world </div>


// #5 unescape

{{@ "<div> hello world </div>"}}

//output: 
 hello world 

```


## Variables definition

```

// #1

{{~ var a =100}}

// #2

{{~ var a =100,b = 200,c=300}}

// #3

{{~ let a =100}}

// #4

{{~ let a =100,b=200,c=300}}

// #5

{{~ const a =100}}

// #6

{{~ const a =100,b=200,c=300}}

```

### if-else

```

// #1

{{~ if (x == 100) }}

{{~ elseif(x == 200) }}

{{~ else if(x == 300) }}

{{~ else}}

{{~ end}}

// #2

{{~ if (x == 200) }}

output....

{{~ /if}}

```

>- both support 'elseif' or 'else if'

>- support use {{~ /if}} for the end

### for-loop

```

// #1

{{~ for (item of array) }}

{{~end}}

// #2

{{~ for (item in array) }}

{{~end}}

// #3

{{~ for (let item of array) }}

{{~end}}

// #4

{{~ for (const item in array) }}

{{~end}}

// #5

{{~ for (key of Object.keys(item) )}}

{{~end}}

// #6

{{~ for (var x = i;x < 100;x++) }}

{{~ end }}

// #7

{{~ for (item of someMethodInvoke().other()) }}

{{~end}}

// #8

{{~ for (var x = i;x < someMethodInvoke().other();x++) }}

{{~ end }}

// #9

{{~ for (var x = i;x < someMethodInvoke().other();x++) }}

{{~ /for }}

```

>- support use {{~ /for}} for the end

### safely access

```

// #1

{{a?.b?.c}}

// #2

{{a.bbbb?().ccc?.ddd}}

```

### Recursive calls

```

var template1 = '{{~for (item of items)}} {{ myRender(item)}} {{~end}}';

var template2 = '{{~for (item of childItems)}} {{ myRender(item)}} {{~end}}';

var fasty = new Fasty({

    share : {

        //custom your render function

        myRender:function (data){

            return fast.render(data,template2)

        },

    }

});

var data = {

  items: [

    {

      otherAttr: "value1",

      childItems: [

        {

          otherAttr: "value1",

          childItems: [],

        },

        {

          otherAttr: "value1",

          childItems: [],

        },

      ],

    },

    {

      otherAttr: "value1",

      childItems: [

        {

          otherAttr: "value1",

          childItems: [],

        },

        {

          otherAttr: "value1",

          childItems: [],

        },

      ],

    },

  ],

};

fast.render(data,template1);

```

### init by options

```javascript

var options = {

    //the shared template data or functions

    share : {

        attr:'text...',

        func1:function (v){

            return v + " kiss~~"

        },

    },

    //default is false

    shareDataFirst: false,

    //default is true, bug not support for IE

    safelyAccess: true,

    

    //support window objects, default false

    windowObjectEnable: false,

    

    //which windwo object support, default null

    //datatype: array, eg: ['$','JQeury']

    windowObjects: null,

    

    //the render() method root data reference name

    rootParaName:'$DATA',

    

    //custom escape method 

    $escape:function (value){return value},

    

    //custom unescape method 

    $unescape:function (value){return value}

}

var fasty = new Fasty(options);

fast.render(template,data)

```

## Author

- Micahel ([email protected]) - 小码科技

- Wechat: wx198819880

## License

Fasty is licensed under the MIT License.