File: options.jsdoc

package info (click to toggle)
node-ejs 2.5.7-1%2Bdeb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 672 kB
  • sloc: javascript: 1,615; sh: 2; makefile: 2
file content (62 lines) | stat: -rw-r--r-- 2,359 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/**
 * Compilation and rendering options.
 *
 * @typedef Options
 * @type {Object}
 *
 * @property {Boolean} [debug=false]
 * Log generated JavaScript source for the EJS template to the console.
 *
 * @property {Boolean} [compileDebug=true]
 * Include additional runtime debugging information in generated template
 * functions.
 *
 * @property {Boolean} [_with=true]
 * Whether or not to use `with () {}` construct in the generated template
 * functions. If set to `false`, data is still accessible through the object
 * whose name is specified by {@link module:ejs.localsName} (default to
 * `locals`).
 *
 * @property {Boolean} [rmWhitespace=false]
 * Remove all safe-to-remove whitespace, including leading and trailing
 * whitespace. It also enables a safer version of `-%>` line slurping for all
 * scriptlet tags (it does not strip new lines of tags in the middle of a
 * line).
 *
 * @property {Boolean} [client=false]
 * Whether or not to compile a {@link ClientFunction} that can be rendered
 * in the browser without depending on ejs.js. Otherwise, a {@link TemplateFunction}
 * will be compiled.
 *
 * @property {EscapeCallback} [escape={@link module:utils.escapeXML}]
 * The escaping function used with `<%=` construct. It is used in rendering
 * and is `.toString()`ed in the generation of client functions.
 *
 * @property {String}  [filename=undefined]
 * The filename of the template. Required for inclusion and caching unless
 * you are using {@link module:ejs.renderFile}. Also used for error reporting.
 *
 * @property {String}  [root=undefined]
 * The path to the project root. When this is set, absolute paths for includes
 * (/filename.ejs) will be relative to the project root.
 *
 * @property {String}  [delimiter='%']
 * The delimiter used in template compilation.
 *
 * @property {Boolean} [cache=false]
 * Whether or not to enable caching of template functions. Beware that
 * the options of compilation are not checked as being the same, so
 * special handling is required if, for example, you want to cache client
 * and regular functions of the same file.
 *
 * Requires `filename` to be set. Only works with rendering function.
 *
 * @property {Object}  [context=this]
 * The Object to which `this` is set during rendering.
 *
 * @property {Object}  [scope=this]
 * Alias of `context`. Deprecated.
 *
 * @static
 * @global
 */