format-usd

Convert a number or string to a United States dollar-formatted string

Installation

First install node.js. Then:

npm install format-usd --save

Usage

var formatUSD = require('format-usd');
formatUSD( { amount: 9000 } ); // '$9000.00'
formatUSD( { amount: '$9000' } ); // '$9000.00'
formatUSD( { amount: 9000.32 } ); // '$9000.32'
formatUSD( { amount: 1.25889349857 } ); // '$1.26'
formatUSD( { amount: 1.25889349857, decimalPlaces: 0 } ); // '$1'
formatUSD( { amount: 1.25889349857, decimalPlaces: 3 } ); // '$1.259'

Contributing

Please read the Contributing guidelines.

Running Tests

We are using nodeunit to test. To run tests, first install nodeunit and any dependencies via npm:

npm install

Run tests with:

npm test

License

The project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Software source code previously released under an open source license and then modified by CFPB staff is considered a "joint work" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open-source license.

For further details, please see: http://www.consumerfinance.gov/developers/sourcecodepolicy/