Content helpers providing number formatting for Handlebars
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
spec
README.md
UNLICENSE
handlebars.numeral.js
package.json

README.md

handlebars.numeral

{{number n}}

Content helpers providing Numeral and Wolsey functionality for Handlebars

Version

0.2.0

Installation

npm install handlebars.numeral

Registering the helpers

 var Handlebars = require("handlebars");
 var NumeralHelper = require("handlebars.numeral");
 NumeralHelper.registerHelpers(Handlebars);

Using the helpers

number

Formats a number

Assuming default en format 0,0[.]00

{{number 3000}}                   → «3,000»

{{number 3000.2}}                 → «3,000.20»

{{number 3000.234}}               → «3,000.23»

{{number 3000.236}}               → «3,000.24»

{{number 30000000}}               → «30,000,000»

Formats with an explicit format

{{number "3000.2" "0"}}           → «3000»

{{number "3000.2" "0.0"}}         → «3000.2»

{{number "3000.234" "0,0[.]0"}}   → «3,000.2»

{{number 30000000 "0a"}}          → «30m»

numeral

Outputs a number as words

{{numeral 2001}}                  → «two thousand and one»

ordinal

Outputs a number as an ordinal

{{ordinal 2001}}                  → «two thousand and first»

As a number

{{ordinal 2001 true}}
{{ordinal 2001 number=true}}           → «2001st»

currency

Formats a number as a currency

{{currency 3000}}                 → «£3,000.00»
{{currency 3000.236}}             → «£3,000.24»

byte

Outputs a number as an ordinal

{{byte 2000000}}                  → «2MB»

Tests

npm test

To see output generated by tests

npm run test:output

Unlicense

handlebars.numeral is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/