templates-each-of

Assemble plugin that adds an async eachOf method for rendering each template in a collection. Uses the .eachOf method from the async library.

Install

Install with npm:

$ npm i templates-each-of --save

Usage

var eachOf = require('templates-each-of');
var templates = require('templates');
var app = templates();

app.use(eachOf());

See the .eachOf docs on the async lib for more details.

API

eachOf

The main export is a function that takes options and returns a "smart plugin" function to be registered with the .use method on the application instance.

A "smart plugin" function automatically detects the instance type: "app", "collection", "view collection" or "list", and adds features or functionality created specifically for that type, ensuring that any features added by the plugin will work consistently regardless of where or how they are used.

Params

options {Object}
returns {Function}

Example

var eachOf = require('templates-each-of');
var templates = require('templates');
var app = templates();

// register the plugin
app.use(eachOf());

.eachOf.app

Adds an eachOf method to app that takes a collection name, an iterator fn and callback as arguments.

Use this only if you don't want to use the main export ("smart plugin"), and only want to register the plugin on app,

Params

name {String}: Name of the view collection to iterate over
fn {Function}: Iterator function
callback {Function}: Done function that exposes err as the only parameter.
returns {undefined}

Example

app.use(eachOf());

app.eachOf('pages', function(view, key, next) {
  // `view` from whatever collection you passed
  // `key` is the view object key
  // call next when finished

  // do some view stuff
  next();
}, function(err) {
  if (err) throw err;
});

.eachOf.views

Adds an eachOf method to view collections that takes an iterator fn and callback as arguments.

Use this only if you don't want to use the main export ("smart plugin"), and only want to register the plugin on view collections

Params

fn {Function}: Iterator function
callback {Function}: Done function that exposes err as the only parameter.
returns {undefined}

Example

app.create('pages');
app.pages.use(eachOf());

app.pages.eachOf(function(page, key, next) {
  // `page` view object
  // `key` is the view object key
  // call next when finished

  // do some view stuff
  next();
}, function(err) {
  if (err) throw err;
});

.eachOf.collection

Adds an eachOf method to generic collections that takes an iterator fn and callback as arguments.

Use this only if you don't want to use the main export ("smart plugin"), and only want to register the plugin on collections.

Params

fn {Function}: Iterator function
callback {Function}: Done function that exposes err as the only parameter.
returns {undefined}

Example

var collection = app.collection();
collection.use(eachOf());

collection.eachOf(function(item, key, next) {
  // `item` item object
  // `key` is the item object key
  // call next when finished

  // do some collection item stuff
  next();
}, function(err) {
  if (err) throw err;
});

.eachOf.list

Adds an eachOf method to List that takes an iterator fn and callback as arguments.

Use this only if you don't want to use the main export ("smart plugin"), and only want to register the plugin on lists.

Params

fn {Function}: Iterator function
callback {Function}: Done function that exposes err as the only parameter.
returns {undefined}

Example

var list = new app.Collection();
list.use(eachOf());

list.eachOf(function(item, key, next) {
  // `item` item object
  // `key` is the item object key
  // call next when finished

  // do some list item stuff
  next();
}, function(err) {
  if (err) throw err;
});

Related projects

assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
assemble-render-file: Assemble plugin for rendering views in a vinyl pipeline. | homepage
assemble-render-string: Assemble plugin that adds a .renderString method for rendering a string with any registered engine. | homepage
assemble-streams: Assemble pipeline plugin for pushing a view collection into a vinyl stream. | homepage
templates: System for creating and managing template collections, and rendering templates with any node.js template engine.… more | homepage

Generate docs

Generate readme and API documentation with [verb][]:

$ npm i -d && npm run docs

Or, if [verb][] is installed globally:

$ verb

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

This file was generated by verb, v0.9.0, on February 14, 2016.

jonschlinkert / templates-each-of Goto Github PK