helper-date

helper-date

Format dates with date.js and moment.js. Uses date.js to parse human readable date phrases, and moment to format the rendered output. Should work with any Handlebars, Lo-Dash, underscore, or any template engine that allows helper functions to be registered. Also compatible with verb, assemble and Template.

Install

Install with npm:

$ npm install --save helper-date

Usage

With Handlebars:

2012
//=> 2010

With Lo-Dash or Underscore:

<%= date("5 years ago", "YYYY") %>
//=> 2010

With Verb (lo-dash, with special delimiters to avoid delimiter collision in markdown docs):

2012
//=> 2010

template

Register the helper for use with any template engine

template.helper('date', require('helper-date'));

assemble

To register the helper for use with assemble v0.6.x:

assemble.helper('date', require('helper-date'));

verb

Register the helper for use with verb:

var verb = require('verb');
verb.helper('date', require('helper-date'));

verb.task('default', function() {
  verb.src('.verb*.md')
    .pipe(verb.dest('./'));
});

handlebars

var handlebars = require('handlebars');
handlebars.registerHelper('date', require('helper-date'));

Usage

2012

lodash or underscore

// as a mixin
_.mixin({date: dateHelper});
_.template('<%= _.date("5 years ago", "YYYY") %>', {});
//=> 2010

// passed on the context
_.template('<%= date("5 years ago", "YYYY") %>', {date: dateHelper});
//=> 2010

// as an import
var settings = {imports: {date: dateHelper}};
_.template('<%= date("5 years ago", "YYYY") %>', {}, settings);
//=> 2010

About

Related projects

• handlebars-helper-moment: A helper to master time! Combining the powers of Assemble, Handlebars.js and Moment.js. This helper… more | homepage
• handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
• helper-dateformat: Template helper for adding formatted dates using node-dateformat. Works with Handlebars, Lo-Dash, underscore, or any… more | homepage
• template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage

Contributing

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

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.2.3, on January 02, 2017.