helper-date

    1.0.1 • Public • Published

    helper-date NPM version NPM monthly downloads NPM total downloads Linux Build Status

    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.

    Follow this project's author, Jon Schlinkert, for updates on this project and others.

    Install

    Install with npm:

    $ npm install --save helper-date

    Usage

    With Handlebars:

    {{date "5 years ago" "YYYY"}}
    //=> 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.0 and greater:

    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

    {{date "5 years ago" "YYYY"}}

    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

    You might also be interested in these projects:

    Contributing

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

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

    Contributors

    Commits Contributor
    20 jonschlinkert
    1 bradtaylorsf

    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Running tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test

    Author

    Jon Schlinkert

    License

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


    This file was generated by verb-generate-readme, v0.6.0, on September 04, 2017.

    Install

    npm i helper-date

    DownloadsWeekly Downloads

    152,856

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert