https://github.com/cfpb/format-usd
Convert a number or string to a USD-formatted string
https://github.com/cfpb/format-usd
Last synced: about 1 year ago
JSON representation
Convert a number or string to a USD-formatted string
- Host: GitHub
- URL: https://github.com/cfpb/format-usd
- Owner: cfpb
- License: cc0-1.0
- Created: 2014-07-21T21:19:20.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T19:33:25.000Z (over 3 years ago)
- Last Synced: 2025-03-23T22:11:21.800Z (about 1 year ago)
- Language: JavaScript
- Size: 101 KB
- Stars: 5
- Watchers: 24
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: COPYING.txt
Awesome Lists containing this project
README
# format-usd [](http://travis-ci.org/cfpb/format-usd)
> Convert a number or string to a United States dollar-formatted string
## Installation
First install [node.js](http://nodejs.org/). Then:
```sh
npm install format-usd --save
```
## Usage
```javascript
var formatUSD = require('format-usd');
formatUSD({ amount: 9000 }); // '$9,000.00'
formatUSD({ amount: '$9000' }); // '$9,000.00'
formatUSD({ amount: 9000.32 }); // '$9,000.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](CONTRIBUTING.md).
### Running Tests
We are using [nodeunit](https://github.com/caolan/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](http://creativecommons.org/publicdomain/zero/1.0/).
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/