feat: get monthly cashflow collection by year (#60)

Author: kvernon

.editorconfig

@@ -2,7 +2,7 @@ root = true
 
 [{*.cjs,*.js,*.js,*.ts}]
 charset = utf-8
-end_of_line = crlf
+end_of_line = lf
 indent_size = 2
 indent_style = space
 insert_final_newline = true

docs/_media/badge.svg

@@ -6,7 +6,7 @@
 
 # Interface: IUserGoal
 
-Defined in: [account/i-user-goal.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-goal.ts#L3)
+Defined in: [account/i-user-goal.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L3)
 
 ## Extended by
 
@@ -18,7 +18,7 @@ Defined in: [account/i-user-goal.ts:3](https://github.com/kvernon/realty-investo
 
 > **monthlyIncomeAmountGoal**: `number`
 
-Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-goal.ts#L7)
+Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L7)
 
 used to determine how much you need want for monthly expenses
 
@@ -28,7 +28,7 @@ used to determine how much you need want for monthly expenses
 
 > **metMonthlyGoal**(`today`, `properties`): `boolean`
 
-Defined in: [account/i-user-goal.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-goal.ts#L13)
+Defined in: [account/i-user-goal.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L14)
 
 method used to help determine if you have met your expenses
 

docs/account/i-user-goal/interfaces/IUserGoal.md

@@ -6,7 +6,7 @@
 
 # Interface: IUserInvestorCheck
 
-Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L9)
+Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L9)
 
 ## Extends
 
@@ -22,7 +22,7 @@ Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/real
 
 > **holdRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]
 
-Defined in: [account/i-user-investor-check.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L23)
+Defined in: [account/i-user-investor-check.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L23)
 
 a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule
 
@@ -32,7 +32,7 @@ a system to determine how to hold onto the properties the longest. This scenario
 
 > `readonly` **ledgerCollection**: [`ILedgerCollection`](../../../ledger/ledger-collection/interfaces/ILedgerCollection.md)
 
-Defined in: [account/i-user-investor-check.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L13)
+Defined in: [account/i-user-investor-check.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L13)
 
 the collection which is used to keep a balance sheet.
 
@@ -42,7 +42,7 @@ the collection which is used to keep a balance sheet.
 
 > **loanSettings**: [`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]
 
-Defined in: [account/i-user-investor-check.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L18)
+Defined in: [account/i-user-investor-check.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L18)
 
 a collection of loan settings for how to get a loan for single family or some other kind of property
 
@@ -52,7 +52,7 @@ a collection of loan settings for how to get a loan for single family or some ot
 
 > **monthlyIncomeAmountGoal**: `number`
 
-Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-goal.ts#L7)
+Defined in: [account/i-user-goal.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L7)
 
 used to determine how much you need want for monthly expenses
 
@@ -66,7 +66,7 @@ used to determine how much you need want for monthly expenses
 
 > **purchaseRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
 
-Defined in: [account/i-user-investor-check.ts:60](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L60)
+Defined in: [account/i-user-investor-check.ts:60](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L60)
 
 a system to weed out the properties you don't want. This scenario says as long as it meets 1 rule
 
@@ -76,7 +76,7 @@ a system to weed out the properties you don't want. This scenario says as long a
 
 > **getAvailableSavings**(`date`, `properties`): `number`
 
-Defined in: [account/i-user-investor-check.ts:55](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L55)
+Defined in: [account/i-user-investor-check.ts:55](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L55)
 
 should be the total balance - savings, using [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), for determining monthly cash to save for single family properties
 
@@ -100,7 +100,7 @@ should be the total balance - savings, using [getMinimumSavings](IUserInvestorCh
 
 > **getMinimumSavings**(`date`, `properties`): `number`
 
-Defined in: [account/i-user-investor-check.ts:48](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L48)
+Defined in: [account/i-user-investor-check.ts:48](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L48)
 
 used to retrieve the amount required to keep in savings
 
@@ -124,7 +124,7 @@ used to retrieve the amount required to keep in savings
 
 > **hasMinimumSavings**(`date`, `properties`): `boolean`
 
-Defined in: [account/i-user-investor-check.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L41)
+Defined in: [account/i-user-investor-check.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L41)
 
 a way to determine if the user has enough money. This is different because with
 single family homes, you would have to save a certain amount of monthly mortgage
@@ -149,7 +149,7 @@ single family homes, you would have to save a certain amount of monthly mortgage
 
 > **hasMoneyToInvest**(`date`, `properties`, `contribution`?): `boolean`
 
-Defined in: [account/i-user-investor-check.ts:33](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-investor-check.ts#L33)
+Defined in: [account/i-user-investor-check.ts:33](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-investor-check.ts#L33)
 
 based upon [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), it checks to see if there is an amount remaining that can be used along with the [contribution](IUserInvestorCheck.md#contribution).
 
@@ -183,7 +183,7 @@ availableSavings - contribution >= 0;
 
 > **metMonthlyGoal**(`today`, `properties`): `boolean`
 
-Defined in: [account/i-user-goal.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/i-user-goal.ts#L13)
+Defined in: [account/i-user-goal.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L14)
 
 method used to help determine if you have met your expenses
 

docs/account/i-user-investor-check/interfaces/IUserInvestorCheck.md

@@ -6,7 +6,7 @@
 
 # Class: User
 
-Defined in: [account/user.ts:32](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L32)
+Defined in: [account/user.ts:32](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L32)
 
 It's the user... as an interface!
 
@@ -20,7 +20,7 @@ It's the user... as an interface!
 
 > **new User**(`ledgerCollection`): [`User`](User.md)
 
-Defined in: [account/user.ts:75](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L75)
+Defined in: [account/user.ts:75](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L75)
 
 #### Parameters
 
@@ -38,7 +38,7 @@ Defined in: [account/user.ts:75](https://github.com/kvernon/realty-investor-time
 
 > **holdRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]
 
-Defined in: [account/user.ts:82](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L82)
+Defined in: [account/user.ts:82](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L82)
 
 a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule
 
@@ -52,7 +52,7 @@ a system to determine how to hold onto the properties the longest. This scenario
 
 > `readonly` **ledgerCollection**: [`ILedgerCollection`](../../../ledger/ledger-collection/interfaces/ILedgerCollection.md)
 
-Defined in: [account/user.ts:36](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L36)
+Defined in: [account/user.ts:36](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L36)
 
 the collection which is used to keep a balance sheet.
 
@@ -66,7 +66,7 @@ the collection which is used to keep a balance sheet.
 
 > **loanSettings**: [`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]
 
-Defined in: [account/user.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L41)
+Defined in: [account/user.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L41)
 
 a collection of loan settings for how to get a loan for single family or some other kind of property
 
@@ -80,7 +80,7 @@ a collection of loan settings for how to get a loan for single family or some ot
 
 > **monthlyIncomeAmountGoal**: `number`
 
-Defined in: [account/user.ts:46](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L46)
+Defined in: [account/user.ts:46](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L46)
 
 used to determine how much you need want for monthly expenses
 
@@ -94,7 +94,7 @@ used to determine how much you need want for monthly expenses
 
 > **monthlySavedAmount**: `number`
 
-Defined in: [account/user.ts:73](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L73)
+Defined in: [account/user.ts:73](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L73)
 
 an amount which the user can save per month after expenses, like, after my pay check I could put this amount into savings
 
@@ -108,7 +108,7 @@ an amount which the user can save per month after expenses, like, after my pay c
 
 > **purchaseRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
 
-Defined in: [account/user.ts:87](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L87)
+Defined in: [account/user.ts:87](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L87)
 
 a system to weed out the properties you don't want. This scenario says as long as it meets 1 rule
 
@@ -122,7 +122,7 @@ a system to weed out the properties you don't want. This scenario says as long a
 
 > **clone**(): [`IUser`](../interfaces/IUser.md)
 
-Defined in: [account/user.ts:171](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L171)
+Defined in: [account/user.ts:171](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L171)
 
 #### Returns
 
@@ -138,7 +138,7 @@ Defined in: [account/user.ts:171](https://github.com/kvernon/realty-investor-tim
 
 > **getAvailableSavings**(`date`, `properties`): `number`
 
-Defined in: [account/user.ts:155](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L155)
+Defined in: [account/user.ts:155](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L155)
 
 should be the total balance - savings, using [getMinimumSavings](User.md#getminimumsavings), for determining monthly cash to save for single family properties
 
@@ -166,7 +166,7 @@ should be the total balance - savings, using [getMinimumSavings](User.md#getmini
 
 > **getEstimatedMonthlyCashFlow**(`today`, `properties`): `number`
 
-Defined in: [account/user.ts:57](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L57)
+Defined in: [account/user.ts:57](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L57)
 
 method used to help determine if you have met your expenses
 
@@ -194,7 +194,7 @@ method used to help determine if you have met your expenses
 
 > **getMinimumSavings**(`date`, `properties`): `number`
 
-Defined in: [account/user.ts:137](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L137)
+Defined in: [account/user.ts:137](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L137)
 
 used to retrieve the amount required to keep in savings
 
@@ -222,7 +222,7 @@ used to retrieve the amount required to keep in savings
 
 > **hasMinimumSavings**(`date`, `properties`): `boolean`
 
-Defined in: [account/user.ts:119](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L119)
+Defined in: [account/user.ts:119](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L119)
 
 a way to determine if the user has enough money. This is different because with
 single family homes, you would have to save a certain amount of monthly mortgage
@@ -251,7 +251,7 @@ single family homes, you would have to save a certain amount of monthly mortgage
 
 > **hasMoneyToInvest**(`date`, `properties`, `contribution`?): `boolean`
 
-Defined in: [account/user.ts:97](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L97)
+Defined in: [account/user.ts:97](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L97)
 
 based upon [getMinimumSavings](User.md#getminimumsavings), it checks to see if there is an amount remaining that can be used along with the [contribution](User.md#contribution).
 
@@ -289,7 +289,7 @@ availableSavings - contribution >= 0;
 
 > **metMonthlyGoal**(`today`, `properties`): `boolean`
 
-Defined in: [account/user.ts:53](https://github.com/kvernon/realty-investor-timeline/blob/cec7f590aef4aded8ee94008f5b37aa0db4daadd/src/account/user.ts#L53)
+Defined in: [account/user.ts:53](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/user.ts#L53)
 
 method used to help determine if you have met your expenses