JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 34078
  • Score
    100M100P100Q139237F
  • License

express.js inspired template-engine manager.

Package Exports

  • engine-cache

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (engine-cache) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

engine-cache NPM version Build Status

express.js inspired template-engine manager.

Install with npm

npm i engine-cache --save

Usage

var Engines = require('engine-cache');

API

Engines

  • engines {Object}: Optionally pass an object of engines to initialize with.
var Engines = require('engine-cache');
var engines = new Engines();

.setEngine

Register the given view engine callback fn as ext.

  • ext {String}
  • options {Object|Function}: or callback fn.
  • fn {Function}: Callback.
  • returns {Object} Engines: to enable chaining.
var consolidate = require('consolidate')
engines.setEngine('hbs', consolidate.handlebars)

.getEngine

Return the engine stored by ext. If no ext is passed, the entire cache is returned.

  • ext {String}: The engine to get.
  • returns {Object}: The specified engine.
var consolidate = require('consolidate')
engine.setEngine('hbs', consolidate.handlebars);

engine.getEngine('hbs');
// => {render: [function], renderFile: [function]}

.load

Load an object of engines onto the cache. Mostly useful for testing, but exposed as a public method.

  • obj {Object}: Engines to load.
  • returns {Object} Engines: to enable chaining.
engines.load(require('consolidate'))

.helpers

Get and set helpers for the given ext (engine). If no ext is passed, the entire helper cache is returned.

  • ext {String}: The helper cache to get and set to.
  • returns {Object}: Object of helpers for the specified engine.

Example:

var helpers = engines.helpers('hbs');
helpers.addHelper('foo', function() {});
helpers.getHelper('foo');
helpers.getHelper();

See helper-cache for any related issues, API details, and documentation.

.clear

Remove ext engine from the cache, or if no value is specified the entire cache is reset.

  • ext {String}: The engine to remove.

Example:

engines.clear()
  • async-helpers: Use async helpers in templates with engines that typically only… more
  • handlebars-helpers: 120+ Handlebars helpers in ~20 categories, for Assemble, YUI, Ghost… more
  • helper-cache: Easily register and get helper functions to be passed to… more
  • template-helpers: Generic JavaScript helpers that can be used with any template… more
  • template: Render templates from any engine. Make custom template types, use… more

Running tests

Install dev dependencies:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

github/jonschlinkert twitter/jonschlinkert

License

Copyright (c) 2014-2015 Jon Schlinkert Released under the MIT license

This file was generated by verb-cli on April 23, 2015.