@cfpb/jumbo-mortgage
v6.0.0
Published
Check if a loan is jumbo or high balance.
Downloads
68
Readme
jumbo-mortgage
Tells you if a loan is "jumbo".
Note: Loan limits increased in 2017 and in 2019. Use v1.x.x of this module if you want 2016 limits. Use v2.x.x for 2017 limits. Use v3.x.x for 2019 limits. Use v4.x.x for 2023. Use v5.x.x for 2024. Use v6.x.x for 2025.
Installation
Grab the dist/jumbo-mortgage.js
file and include it at the bottom of your page:
<script src="jumbo-mortgage.js"></script>
Or use Node/Browserify:
npm install jumbo-mortgage --save
var jumbo = require('jumbo-mortgage');
Usage
var loan = jumbo({
loanType: 'conf', // conf (conforming), fha or va
loanAmount: 250000
});
console.log( loan );
// {
// success: true,
// isJumbo: false
// }
// Loans above $424,100 *might* be jumbo. It depends on the county. You'll need to provide county limits.
var loan = jumbo({
loanType: 'conf',
loanAmount: 450000
});
console.log( loan );
// {
// success: false,
// needCounty: true,
// msg: 'Please provide county limits.'
// }
// These county limits are for Alameda County, CA.
loan = jumbo({
loanType: 'conf',
loanAmount: 750000,
gseCountyLimit: 625500,
fhaCountyLimit: 625500,
vaCountyLimit: 1050000
});
console.log( loan );
// {
// success: true,
// isJumbo: true,
// type: 'jumbo',
// msg: 'When you borrow more than $625,500 in your county, the only loan type available to you is a jumbo (non-conforming) loan.'
// }
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/