cartodb/grunt-contrib-jst
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update jst-options.md

Browse Source 
[ci skip]
This commit is contained in:
XhmikosR 2015-10-14 17:11:06 +03:00
parent 0b22db3937
commit dba65df851
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/jst-options.md
View File

@ -1,20 +1,20 @@
# Options # Options
## separator ## separator
Type: `String` Type: `String`
Default: linefeed + linefeed Default: linefeed + linefeed
Concatenated files will be joined on this string. Concatenated files will be joined on this string.
## namespace ## namespace
Type: `String` Type: `String`
Default: 'JST' Default: `'JST'`
The namespace in which the precompiled templates will be assigned. Use dot notation (e.g. App.Templates) for nested namespaces or false for no namespace wrapping. When false with amd option set true, templates will be returned directly from the AMD wrapper. The namespace in which the precompiled templates will be assigned. Use dot notation (e.g. App.Templates) for nested namespaces or false for no namespace wrapping. When false with amd option set true, templates will be returned directly from the AMD wrapper.
## processName ## processName
Type: `function` Type: `function`
Default: null Default: `null`
This option accepts a function which takes one argument (the template filepath) and returns a string which will be used as the key for the precompiled template object. The example below stores all templates on the default JST namespace in capital letters. This option accepts a function which takes one argument (the template filepath) and returns a string which will be used as the key for the precompiled template object. The example below stores all templates on the default JST namespace in capital letters.
@ -27,8 +27,8 @@ options: {
``` ```
## templateSettings ## templateSettings
Type: `Object` Type: `Object`
Default: null Default: `null`
The settings passed to underscore when compiling templates. The settings passed to underscore when compiling templates.
@ -48,8 +48,8 @@ jst: {
``` ```
## prettify ## prettify
Type: `boolean` Type: `boolean`
Default: false Default: `false`
When doing a quick once-over of your compiled template file, it's nice to see When doing a quick once-over of your compiled template file, it's nice to see
an easy-to-read format that has one line per template. This will accomplish an easy-to-read format that has one line per template. This will accomplish
@ -62,8 +62,8 @@ options: {
``` ```
## amd ## amd
Type: `boolean` Type: `boolean`
Default: false Default: `false`
Wraps the output file with an AMD define function and returns the compiled template namespace unless namespace has been explicitly set to false in which case the template function will be returned directly. Wraps the output file with an AMD define function and returns the compiled template namespace unless namespace has been explicitly set to false in which case the template function will be returned directly.