Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

engine-cache

Package Overview
Dependencies
Maintainers
2
Versions
51
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

engine-cache

express.js inspired template-engine manager.

  • 0.14.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
33K
increased by18.15%
Maintainers
2
Weekly downloads
 
Created
Source

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

Params

  • engines {Object}: Optionally pass an object of engines to initialize with.

Example

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

.setEngine

Register the given view engine callback fn as ext.

Params

  • ext {String}
  • options {Object|Function}: or callback fn.
  • fn {Function}: Callback.
  • returns {Object} Engines: to enable chaining.

Example

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.

Params

  • ext {String}: The engine to get.
  • returns {Object}: The specified engine.

Example

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.

Params

  • obj {Object}: Engines to load.
  • returns {Object} Engines: to enable chaining.

Example

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.

Example:

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

Params

  • 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('bar', function() {});
helpers.getHelper('bar');
helpers.getHelper();

.clear

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

Example:

Params

  • ext {String}: The engine to remove.

Example

engines.clear()
  • async-helpers: Use async helpers in templates with engines that typically only handle sync helpers. Handlebars and… more
  • helper-cache: Easily register and get helper functions to be passed to any template engine or node.js… more
  • handlebars-helpers: 120+ Handlebars helpers in ~20 categories, for Assemble, YUI, Ghost or any Handlebars project. Includes… more
  • template: Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… more
  • template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… 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

License

Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on June 18, 2015.

Keywords

FAQs

Package last updated on 09 Jul 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc