@cubedelement.com/realty-investor-timeline 5.5.1 → 5.7.0

package/docs/investments/user-invest-result/interfaces/IUserInvestResult.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/user-invest-result](../index.md) / IUserInvestResult
-
-# Interface: IUserInvestResult
-
-Defined in: [investments/user-invest-result.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-invest-result.ts#L3)
-
-## Properties
-
-### investmentReason
-
-> **investmentReason**: [`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-Defined in: [investments/user-invest-result.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-invest-result.ts#L5)
-
----
-
-### message
-
-> **message**: `string`
-
-Defined in: [investments/user-invest-result.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-invest-result.ts#L4)

package/docs/investments/user-result-estimates/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / investments/user-result-estimates
-
-# investments/user-result-estimates
-
-## Type Aliases
-
-- [UserResultEstimates](type-aliases/UserResultEstimates.md)

package/docs/investments/user-result-estimates/type-aliases/UserResultEstimates.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/user-result-estimates](../index.md) / UserResultEstimates
-
-# Type Alias: UserResultEstimates()
-
-> **UserResultEstimates**: (`rental`, `holdRules`, `purchaseRules`, `date`) => [`UserInvestResult`](../../user-invest-result/classes/UserInvestResult.md)[]
-
-Defined in: [investments/user-result-estimates.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-result-estimates.ts#L7)
-
-## Parameters
-
-### rental
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-### holdRules
-
-[`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]
-
-### purchaseRules
-
-[`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
-
-### date
-
-`Date`
-
-## Returns
-
-[`UserInvestResult`](../../user-invest-result/classes/UserInvestResult.md)[]

package/docs/ledger/i-ledger-summary/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / ledger/i-ledger-summary
-
-# ledger/i-ledger-summary
-
-## Interfaces
-
-- [ILedgerSummary](interfaces/ILedgerSummary.md)

package/docs/ledger/i-ledger-summary/interfaces/ILedgerSummary.md

@@ -1,57 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [ledger/i-ledger-summary](../index.md) / ILedgerSummary
-
-# Interface: ILedgerSummary
-
-Defined in: [ledger/i-ledger-summary.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/i-ledger-summary.ts#L1)
-
-## Properties
-
-### averageCashFlow
-
-> **averageCashFlow**: `number`
-
-Defined in: [ledger/i-ledger-summary.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/i-ledger-summary.ts#L5)
-
----
-
-### balance
-
-> **balance**: `number`
-
-Defined in: [ledger/i-ledger-summary.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/i-ledger-summary.ts#L3)
-
----
-
-### cashFlow
-
-> **cashFlow**: `number`
-
-Defined in: [ledger/i-ledger-summary.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/i-ledger-summary.ts#L4)
-
----
-
-### date
-
-> **date**: `Date`
-
-Defined in: [ledger/i-ledger-summary.ts:2](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/i-ledger-summary.ts#L2)
-
----
-
-### equity
-
-> **equity**: `number`
-
-Defined in: [ledger/i-ledger-summary.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/i-ledger-summary.ts#L7)
-
----
-
-### purchases
-
-> **purchases**: `number`
-
-Defined in: [ledger/i-ledger-summary.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/i-ledger-summary.ts#L6)

package/docs/ledger/index.md

@@ -1,43 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../modules.md) / ledger
-
-# ledger
-
-## References
-
-### ILedgerCollection
-
-Re-exports [ILedgerCollection](ledger-collection/interfaces/ILedgerCollection.md)
-
----
-
-### ILedgerSummary
-
-Re-exports [ILedgerSummary](i-ledger-summary/interfaces/ILedgerSummary.md)
-
----
-
-### LedgerCollection
-
-Re-exports [LedgerCollection](ledger-collection/classes/LedgerCollection.md)
-
----
-
-### LedgerItem
-
-Re-exports [LedgerItem](ledger-item/classes/LedgerItem.md)
-
----
-
-### LedgerItemPredicate
-
-Re-exports [LedgerItemPredicate](ledger-collection/type-aliases/LedgerItemPredicate.md)
-
----
-
-### LedgerItemType
-
-Re-exports [LedgerItemType](ledger-item-type/enumerations/LedgerItemType.md)

package/docs/ledger/ledger-collection/classes/LedgerCollection.md

@@ -1,425 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [ledger/ledger-collection](../index.md) / LedgerCollection
-
-# Class: LedgerCollection
-
-Defined in: [ledger/ledger-collection.ts:82](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L82)
-
-## Implements
-
-- [`ILedgerCollection`](../interfaces/ILedgerCollection.md)
-
-## Constructors
-
-### new LedgerCollection()
-
-> **new LedgerCollection**(): [`LedgerCollection`](LedgerCollection.md)
-
-Defined in: [ledger/ledger-collection.ts:95](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L95)
-
-#### Returns
-
-[`LedgerCollection`](LedgerCollection.md)
-
-## Methods
-
-### add()
-
-> **add**(`item`): `void`
-
-Defined in: [ledger/ledger-collection.ts:125](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L125)
-
-#### Parameters
-
-##### item
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md) | `Iterable`\<[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)\>
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`add`](../interfaces/ILedgerCollection.md#add)
-
----
-
-### clone()
-
-> **clone**(): [`ILedgerCollection`](../interfaces/ILedgerCollection.md)
-
-Defined in: [ledger/ledger-collection.ts:368](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L368)
-
-#### Returns
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md)
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`clone`](../interfaces/ILedgerCollection.md#clone)
-
----
-
-### filter()
-
-> **filter**(`pred`?): [`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
-Defined in: [ledger/ledger-collection.ts:99](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L99)
-
-#### Parameters
-
-##### pred?
-
-[`LedgerItemPredicate`](../type-aliases/LedgerItemPredicate.md)
-
-#### Returns
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`filter`](../interfaces/ILedgerCollection.md#filter)
-
----
-
-### getAvailableSavings()
-
-> **getAvailableSavings**(`date`, `properties`, `minMonthsRequired`): `number`
-
-Defined in: [ledger/ledger-collection.ts:346](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L346)
-
-should be the total balance - savings for single family
-
-#### Parameters
-
-##### date
-
-`Date`
-
-##### properties
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
-
-##### minMonthsRequired
-
-`number` = `6`
-
-#### Returns
-
-`number`
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getAvailableSavings`](../interfaces/ILedgerCollection.md#getavailablesavings)
-
----
-
-### getAverageByType()
-
-> **getAverageByType**(`collection`, `type`): `number`
-
-Defined in: [ledger/ledger-collection.ts:176](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L176)
-
-#### Parameters
-
-##### collection
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
-##### type
-
-[`LedgerItemType`](../../ledger-item-type/enumerations/LedgerItemType.md)
-
-#### Returns
-
-`number`
-
----
-
-### getBalance()
-
-> **getBalance**(`date`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:115](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L115)
-
-the total balance in the ledger collection
-
-#### Parameters
-
-##### date?
-
-`Date`
-
-#### Returns
-
-`number`
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getBalance`](../interfaces/ILedgerCollection.md#getbalance)
-
----
-
-### getCashFlowMonth()
-
-> **getCashFlowMonth**(`date`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:215](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L215)
-
-#### Parameters
-
-##### date?
-
-`Date`
-
-#### Returns
-
-`number`
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getCashFlowMonth`](../interfaces/ILedgerCollection.md#getcashflowmonth)
-
----
-
-### getCashFlowMonthCollection()
-
-> **getCashFlowMonthCollection**(`year`?): `number`[]
-
-Defined in: [ledger/ledger-collection.ts:180](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L180)
-
-used to get the cashFlow of all 12 months
-
-#### Parameters
-
-##### year?
-
-`number`
-
-#### Returns
-
-`number`[]
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getCashFlowMonthCollection`](../interfaces/ILedgerCollection.md#getcashflowmonthcollection)
-
----
-
-### getCashFlowYearAverage()
-
-> **getCashFlowYearAverage**(`date`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:197](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L197)
-
-used to get the average cash flow for the year.
-
-#### Parameters
-
-##### date?
-
-`Date`
-
-#### Returns
-
-`number`
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getCashFlowYearAverage`](../interfaces/ILedgerCollection.md#getcashflowyearaverage)
-
----
-
-### getLastLedgerMonth()
-
-> **getLastLedgerMonth**(): [`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
-Defined in: [ledger/ledger-collection.ts:358](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L358)
-
-#### Returns
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getLastLedgerMonth`](../interfaces/ILedgerCollection.md#getlastledgermonth)
-
----
-
-### getLatestLedgerItem()
-
-> **getLatestLedgerItem**(): [`LedgerItem`](../../ledger-item/classes/LedgerItem.md)
-
-Defined in: [ledger/ledger-collection.ts:350](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L350)
-
-#### Returns
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getLatestLedgerItem`](../interfaces/ILedgerCollection.md#getlatestledgeritem)
-
----
-
-### getMinimumSavings()
-
-> **getMinimumSavings**(`properties`, `date`, `minMonthsRequired`): `number`
-
-Defined in: [ledger/ledger-collection.ts:146](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L146)
-
-This method gets the total of savings needed for all properties by x amount of months.
-
-#### Parameters
-
-##### properties
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
-
-##### date
-
-`Date`
-
-##### minMonthsRequired
-
-`number` = `6`
-
-#### Returns
-
-`number`
-
-#### Examples
-
-```ts
-Example, you typically need 6 months of month per single family home, so if you had 3 homes at 6 months and mortgage was $1000. It would be doing the following: `getMinimumSavings = 3 (SF) * $1000 (mort) * 6 (months) = $18,000`
-```
-
-```ts
-totals all properties getExpensesByDate * amount needed to save by month, so properties[].getExpensesByDate() * minMonthsRequired.
-```
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getMinimumSavings`](../interfaces/ILedgerCollection.md#getminimumsavings)
-
----
-
-### getSummariesAnnual()
-
-> **getSummariesAnnual**(`year`?): [`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)[]
-
-Defined in: [ledger/ledger-collection.ts:299](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L299)
-
-#### Parameters
-
-##### year?
-
-`number`
-
-#### Returns
-
-[`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)[]
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getSummariesAnnual`](../interfaces/ILedgerCollection.md#getsummariesannual)
-
----
-
-### getSummaryAnnual()
-
-> **getSummaryAnnual**(`year`?): [`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
-Defined in: [ledger/ledger-collection.ts:273](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L273)
-
-#### Parameters
-
-##### year?
-
-`number`
-
-#### Returns
-
-[`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getSummaryAnnual`](../interfaces/ILedgerCollection.md#getsummaryannual)
-
----
-
-### getSummaryMonth()
-
-> **getSummaryMonth**(`date`): [`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
-Defined in: [ledger/ledger-collection.ts:233](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L233)
-
-#### Parameters
-
-##### date
-
-`Date`
-
-#### Returns
-
-[`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`getSummaryMonth`](../interfaces/ILedgerCollection.md#getsummarymonth)
-
----
-
-### hasMinimumSavings()
-
-> **hasMinimumSavings**(`properties`, `date`, `minMonthsRequired`): `boolean`
-
-Defined in: [ledger/ledger-collection.ts:172](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L172)
-
-determines if there is enough money in the account while forcing a hold on the [getMinimumSavings](LedgerCollection.md#getminimumsavings) amount.
-
-#### Parameters
-
-##### properties
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
-
-##### date
-
-`Date`
-
-##### minMonthsRequired
-
-`number` = `6`
-
-#### Returns
-
-`boolean`
-
-#### Example
-
-```
-hasMinimumSavings = getBalance >= getMinimumSavings
-```
-
-#### Implementation of
-
-[`ILedgerCollection`](../interfaces/ILedgerCollection.md).[`hasMinimumSavings`](../interfaces/ILedgerCollection.md#hasminimumsavings)
-
----
-
-### isEmpty()
-
-> **isEmpty**(): `boolean`
-
-Defined in: [ledger/ledger-collection.ts:132](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L132)
-
-is the collection empty?
-
-#### Returns
-
-`boolean`

package/docs/ledger/ledger-collection/index.md

@@ -1,19 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / ledger/ledger-collection
-
-# ledger/ledger-collection
-
-## Classes
-
-- [LedgerCollection](classes/LedgerCollection.md)
-
-## Interfaces
-
-- [ILedgerCollection](interfaces/ILedgerCollection.md)
-
-## Type Aliases
-
-- [LedgerItemPredicate](type-aliases/LedgerItemPredicate.md)