thewall-templater-dustjs

About

This is a template handler compatible with The Wall.

Inside here, you have the template handler that conforms to the interface expected by the wall, it has the template engine (in this case Dust) included and any additional template "helpers" as required.

Getting Started

If you want to work on this repo you will need to install the dependencies

$ git clone [email protected]:holidayextras/the-wall-templater-dustjs.git

and then fetch the dependencies

$ npm install

To include this module in your project add the following to your package.json

"the-wall-templater-dustjs": "git+ssh://[email protected]:holidayextras/the-wall-templater-dustjs.git"

Documentation

Helpers

• _sortByNumber Sorting method that orders a list of things based on a child node, which is a number

• _sortByMapping Sorting method that orders a list of things based on a provided map

• _filterSeats A filter that nests package rates under theatre sections - Needs to be moved

• _calcDistance A helper to calc straight distance using two locations with lat and long.

• _loadTemplate A special helper so we can load templates with a namespace. Can pass through variables to the templates.

• _formatDate using momentjs this helper takes a date string and a format and returns a formatted date string.

• _dateDifferential using momentjs this helper takes a startDate and endDate to calculate the days difference

• _formatNumber using 'numeraljs' this helpers takes a number string and a format and returns a formatted date string.

• _forEach Itterate through provided object/array/string.

Tests

Tests will run using the default grunt task but can also be called stand-alone using:

$ npm test

Contributing

Code is linted checked against the style guide with Standard, running npm test will run all tests.

License

Copyright (c) 2016 Shortbreaks Licensed under the MIT license.