carltonf / finance.js

A JavaScript library for common financial calculations

Fork Notes

1. I am taking some Finance course, this project serves both as nodejs and Finance practices.
2. I anticipate a lot of changes, so I might well start my own Finance Javascript library in the future.

---

Finance.js

Finance.js makes it easy to incorporate common financial calculations into your application. The library is built on pure JavaScript without any dependencies. For full documentation, please visit financejs.org.

This project is hosted on GitHub. You can report bugs and discuss features on the GitHub issues page. Finance.js is available for use under the MIT software license.

##Getting Started

Installation

  npm install financejs --save

or

• Download or fork the repository from GitHub.
• Extract the file finance.js from the project and include it in your application on the client side.

Example Usage

  // to calculate formulas related to compound interest
  var ci = require('financejs')["Compound Inerest"];
  
  ci.FV(100, 100, 2);
  // or
  ci.FV({pv: 100, k: 100, n: 2});

To see all available calculations and their usage, visit financejs.org.

Tests

   npm test

Contributing

Contributions are welcome to aid in the expansion of the library. In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and please lint and test your code.

To Do

• Expand library with more financial calculations
• Include edge cases in testing, if any