1. module pug
   1. function pug.__express (path, options, fn)
   2. function pug.compile (str, options)
   3. function pug.compileClient (str, options)
   4. function pug.compileClientWithDependenciesTracked (str, options)
   5. function pug.compileFile (path, options)
   6. function pug.compileFileClient (path, options)
   7. function pug.render (str, options, fn)
   8. function pug.renderFile (path, options, fn)
   9. object pug.cache
   10. object pug.filters
   11. object pug.runtime

module pug

function pug.__express (path, options, fn)

• description and source-code

  __express = function (path, options, fn) {
    if(options.compileDebug == undefined && process.env.NODE_ENV === 'production') {
      options.compileDebug = false;
    }
    exports.renderFile(path, options, fn);
  }

• example usage

  n/a

function pug.compile (str, options)

• description and source-code

  compile = function (str, options){
    var options = options || {}
  
    str = String(str);
  
    var parsed = compileBody(str, {
      compileDebug: options.compileDebug !== false,
      filename: options.filename,
      basedir: options.basedir,
      pretty: options.pretty,
      doctype: options.doctype,
      inlineRuntimeFunctions: options.inlineRuntimeFunctions,
      globals: options.globals,
      self: options.self,
      includeSources: options.compileDebug === true,
      debug: options.debug,
      templateName: 'template'
    });
  
    var res = options.inlineRuntimeFunctions
      ? new Function('', parsed.body + ';return template;')()
      : runtimeWrap(parsed.body);
  
    res.dependencies = parsed.dependencies;
  
    return res;
  }

• example usage

  n/a

function pug.compileClient (str, options)

• description and source-code

  compileClient = function (str, options) {
    return exports.compileClientWithDependenciesTracked(str, options).body;
  }

• example usage

  n/a

function pug.compileClientWithDependenciesTracked (str, options)

• description and source-code

  compileClientWithDependenciesTracked = function (str, options){
    var options = options || {};
  
    str = String(str);
    var parsed = compileBody(str, {
      compileDebug: options.compileDebug,
      filename: options.filename,
      basedir: options.basedir,
      pretty: options.pretty,
      doctype: options.doctype,
      inlineRuntimeFunctions: options.inlineRuntimeFunctions !== false,
      globals: options.globals,
      self: options.self,
      includeSources: options.compileDebug,
      debug: options.debug,
      templateName: options.name || 'template'
    });
  
    return {body: parsed.body, dependencies: parsed.dependencies};
  }

• example usage

  n/a

function pug.compileFile (path, options)

• description and source-code

  compileFile = function (path, options) {
    options = options || {};
    options.filename = path;
    return handleTemplateCache(options);
  }

• example usage

  n/a

function pug.compileFileClient (path, options)

• description and source-code

  compileFileClient = function (path, options){
    var key = path + ':client';
    options = options || {};
  
    options.filename = path;
  
    if (options.cache && exports.cache[key]) {
      return exports.cache[key];
    }
  
    var str = fs.readFileSync(options.filename, 'utf8');
    var out = exports.compileClient(str, options);
    if (options.cache) exports.cache[key] = out;
    return out;
  }

• example usage

  ...
  
  
  
  var jade = require('./');
  var resolvedJade = require.resolve('./');
  
  function compileTemplate(module, filename) {
  var template = jade.compileFileClient(filename, {inlineRuntimeFunctions: false});
  var body = "var jade = require('" + resolvedJade + "').runtime;\n\n" +
             "module.exports = " + template + ";";
  module._compile(body, filename);
  }
  
  if (require.extensions) {
  require.extensions['.jade'] = compileTemplate
  ...

function pug.render (str, options, fn)

• description and source-code

  render = function (str, options, fn){
    // support callback API
    if ('function' == typeof options) {
      fn = options, options = undefined;
    }
    if (typeof fn === 'function') {
      var res
      try {
        res = exports.render(str, options);
      } catch (ex) {
        return fn(ex);
      }
      return fn(null, res);
    }
  
    options = options || {};
  
    // cache requires .filename
    if (options.cache && !options.filename) {
      throw new Error('the "filename" option is required for caching');
    }
  
    return handleTemplateCache(options, str)(options);
  }

• example usage

  n/a

function pug.renderFile (path, options, fn)

• description and source-code

  renderFile = function (path, options, fn){
    // support callback API
    if ('function' == typeof options) {
      fn = options, options = undefined;
    }
    if (typeof fn === 'function') {
      var res
      try {
        res = exports.renderFile(path, options);
      } catch (ex) {
        return fn(ex);
      }
      return fn(null, res);
    }
  
    options = options || {};
  
    options.filename = path;
    return handleTemplateCache(options)(options);
  }

• example usage

  n/a