feat: quarterly cash flow (#74)

* feat: quarterly cash flow

* docs: updated items

* fix: version revert

* docs: rm from package

Author: kvernon

.npmignore

@@ -25,3 +25,5 @@ commitlint.config.js
 lint-staged.config.js
 *.tgz
 release.config.js
+/.github
+/docs

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/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L3)
+Defined in: [account/i-user-goal.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/5a4b50c05937ef4acec617ccfb5124957036558c/src/account/i-user-goal.ts#L1)
 
 ## Extended by
 
@@ -18,29 +18,45 @@ 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/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L7)
+Defined in: [account/i-user-goal.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/5a4b50c05937ef4acec617ccfb5124957036558c/src/account/i-user-goal.ts#L5)
 
 used to determine how much you need want for monthly expenses
 
 ## Methods
 
-### metMonthlyGoal()
+### metAverageQuarterlyGoal()
 
-> **metMonthlyGoal**(`today`, `properties`): `boolean`
+> **metAverageQuarterlyGoal**(`today`): `boolean`
 
-Defined in: [account/i-user-goal.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L14)
+Defined in: [account/i-user-goal.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/5a4b50c05937ef4acec617ccfb5124957036558c/src/account/i-user-goal.ts#L17)
 
-method used to help determine if you have met your expenses
+takes data from a quarterly average cash flow and compares it to the monthly goal. The reason on quarterly is that apartments do distributions quarterly, so you have to spread those out monthly
 
 #### Parameters
 
 ##### today
 
 `Date`
 
-##### properties
+#### Returns
+
+`boolean`
+
+---
+
+### metMonthlyGoal()
+
+> **metMonthlyGoal**(`today`): `boolean`
+
+Defined in: [account/i-user-goal.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/5a4b50c05937ef4acec617ccfb5124957036558c/src/account/i-user-goal.ts#L11)
 
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
+method used to help determine if you have met your expenses
+
+#### Parameters
+
+##### today
+
+`Date`
 
 #### Returns
 

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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L7)
+Defined in: [account/i-user-goal.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/5a4b50c05937ef4acec617ccfb5124957036558c/src/account/i-user-goal.ts#L5)
 
 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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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/c7446a8a5576468ac5874a2dd8323180fa97a55b/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/5a4b50c05937ef4acec617ccfb5124957036558c/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).
 
@@ -179,23 +179,43 @@ availableSavings - contribution >= 0;
 
 ---
 
-### metMonthlyGoal()
+### metAverageQuarterlyGoal()
 
-> **metMonthlyGoal**(`today`, `properties`): `boolean`
+> **metAverageQuarterlyGoal**(`today`): `boolean`
 
-Defined in: [account/i-user-goal.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/account/i-user-goal.ts#L14)
+Defined in: [account/i-user-goal.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/5a4b50c05937ef4acec617ccfb5124957036558c/src/account/i-user-goal.ts#L17)
 
-method used to help determine if you have met your expenses
+takes data from a quarterly average cash flow and compares it to the monthly goal. The reason on quarterly is that apartments do distributions quarterly, so you have to spread those out monthly
 
 #### Parameters
 
 ##### today
 
 `Date`
 
-##### properties
+#### Returns
 
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
+`boolean`
+
+#### Inherited from
+
+[`IUserGoal`](../../i-user-goal/interfaces/IUserGoal.md).[`metAverageQuarterlyGoal`](../../i-user-goal/interfaces/IUserGoal.md#metaveragequarterlygoal)
+
+---
+
+### metMonthlyGoal()
+
+> **metMonthlyGoal**(`today`): `boolean`
+
+Defined in: [account/i-user-goal.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/5a4b50c05937ef4acec617ccfb5124957036558c/src/account/i-user-goal.ts#L11)
+
+method used to help determine if you have met your expenses
+
+#### Parameters
+
+##### today
+
+`Date`
 
 #### Returns