Date helper for displaying elapsed time in a human-readable format. Can be used as a JavaScript utility or template helper with handlebars, lo-dash or any template engine that supports helper functions.
Install with npm
npm i helper-timeago --save
var timeago = require('helper-timeago');
timeago(new Date('2/10/1994'))
//=> '20 years ago'
With Lo-Dash or Underscore:
<%= timeago("index.js") %>
With Handlebars:
With Verb (lo-dash, with special delimiters to avoid delimiter collision in markdown docs):
{%= timeago('index.js') %}
npm test
See the tests for actual usage examples.
This should work with any engine, here are a few examples
Register the helper for use with any template engine
template.helper('timeago', require('helper-timeago'));
To register the helper for use with assemble v0.6.x:
assemble.helper('timeago', require('helper-timeago'));
Register the helper for use with verb:
var verb = require('verb');
verb.helper('timeago', require('helper-timeago'));
verb.task('default', function() {
verb.src('.verb*.md')
.pipe(verb.dest('./'));
});
var handlebars = require('handlebars');
handlebars.registerHelper('timeago', require('helper-timeago'));
// as a mixin
_.mixin({timeago: timeagoHelper});
_.template('<%= _.timeago("fixtures/*.js") %>', {});
// passed on the context
_.template('<%= timeago("fixtures/*.js") %>', {timeago: timeagoHelper});
// as an import
var settings = {imports: {timeago: timeagoHelper}};
_.template('<%= timeago("fixtures/*.js") %>', {}, settings);
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. To request or contribute a helper to the github.com/helpers org, please read this contributing guide to get started.
Jon Schlinkert
Copyright (c) 2014 Jon Schlinkert
Released under the MIT license
This file was generated by verb on December 07, 2014. To update, run npm i -g verb && verb
.