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

package/docs/ledger/ledger-collection/interfaces/ILedgerCollection.md

@@ -1,313 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [ledger/ledger-collection](../index.md) / ILedgerCollection
-
-# Interface: ILedgerCollection
-
-Defined in: [ledger/ledger-collection.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L10)
-
-## Methods
-
-### add()
-
-> **add**(`item`): `void`
-
-Defined in: [ledger/ledger-collection.ts:19](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L19)
-
-#### Parameters
-
-##### item
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md) | `Iterable`\<[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)\>
-
-#### Returns
-
-`void`
-
----
-
-### clone()
-
-> **clone**(): [`ILedgerCollection`](ILedgerCollection.md)
-
-Defined in: [ledger/ledger-collection.ts:77](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L77)
-
-#### Returns
-
-[`ILedgerCollection`](ILedgerCollection.md)
-
----
-
-### filter()
-
-> **filter**(`pred`?): [`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
-Defined in: [ledger/ledger-collection.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L17)
-
-#### Parameters
-
-##### pred?
-
-[`LedgerItemPredicate`](../type-aliases/LedgerItemPredicate.md)
-
-#### Returns
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
----
-
-### getAvailableSavings()
-
-> **getAvailableSavings**(`date`, `properties`, `minMonthsRequired`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:71](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L71)
-
-should be the total balance - savings for single family
-
-#### Parameters
-
-##### date
-
-`Date`
-
-##### properties
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
-
-##### minMonthsRequired?
-
-`number`
-
-#### Returns
-
-`number`
-
----
-
-### getBalance()
-
-> **getBalance**(`date`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:15](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L15)
-
-the total balance in the ledger collection
-
-#### Parameters
-
-##### date?
-
-`Date`
-
-#### Returns
-
-`number`
-
----
-
-### getCashFlowMonth()
-
-> **getCashFlowMonth**(`date`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:21](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L21)
-
-#### Parameters
-
-##### date?
-
-`Date`
-
-#### Returns
-
-`number`
-
----
-
-### getCashFlowMonthCollection()
-
-> **getCashFlowMonthCollection**(`year`?): `number`[]
-
-Defined in: [ledger/ledger-collection.ts:51](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L51)
-
-used to get the cashFlow of all 12 months
-
-#### Parameters
-
-##### year?
-
-`number`
-
-#### Returns
-
-`number`[]
-
----
-
-### getCashFlowYearAverage()
-
-> **getCashFlowYearAverage**(`date`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:57](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L57)
-
-used to get the average cash flow for the year.
-
-#### Parameters
-
-##### date?
-
-`Date`
-
-#### Returns
-
-`number`
-
----
-
-### getLastLedgerMonth()
-
-> **getLastLedgerMonth**(): [`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
-Defined in: [ledger/ledger-collection.ts:75](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L75)
-
-#### Returns
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)[]
-
----
-
-### getLatestLedgerItem()
-
-> **getLatestLedgerItem**(): [`LedgerItem`](../../ledger-item/classes/LedgerItem.md)
-
-Defined in: [ledger/ledger-collection.ts:73](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L73)
-
-#### Returns
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)
-
----
-
-### getMinimumSavings()
-
-> **getMinimumSavings**(`properties`, `date`, `minMonthsRequired`?): `number`
-
-Defined in: [ledger/ledger-collection.ts:33](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L33)
-
-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`
-
-#### 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.
-```
-
----
-
-### getSummariesAnnual()
-
-> **getSummariesAnnual**(`year`?): [`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)[]
-
-Defined in: [ledger/ledger-collection.ts:63](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L63)
-
-#### Parameters
-
-##### year?
-
-`number`
-
-#### Returns
-
-[`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)[]
-
----
-
-### getSummaryAnnual()
-
-> **getSummaryAnnual**(`year`?): [`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
-Defined in: [ledger/ledger-collection.ts:61](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L61)
-
-#### Parameters
-
-##### year?
-
-`number`
-
-#### Returns
-
-[`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
----
-
-### getSummaryMonth()
-
-> **getSummaryMonth**(`date`): [`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
-Defined in: [ledger/ledger-collection.ts:59](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L59)
-
-#### Parameters
-
-##### date
-
-`Date`
-
-#### Returns
-
-[`ILedgerSummary`](../../i-ledger-summary/interfaces/ILedgerSummary.md)
-
----
-
-### hasMinimumSavings()
-
-> **hasMinimumSavings**(`properties`, `date`, `minMonthsRequired`?): `boolean`
-
-Defined in: [ledger/ledger-collection.ts:45](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L45)
-
-determines if there is enough money in the account while forcing a hold on the [getMinimumSavings](ILedgerCollection.md#getminimumsavings) amount.
-
-#### Parameters
-
-##### properties
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
-
-##### date
-
-`Date`
-
-##### minMonthsRequired?
-
-`number`
-
-#### Returns
-
-`boolean`
-
-#### Example
-
-```
-hasMinimumSavings = getBalance >= getMinimumSavings
-```

package/docs/ledger/ledger-collection/type-aliases/LedgerItemPredicate.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [ledger/ledger-collection](../index.md) / LedgerItemPredicate
-
-# Type Alias: LedgerItemPredicate()
-
-> **LedgerItemPredicate**: (`x`, `index`) => `boolean`
-
-Defined in: [ledger/ledger-collection.ts:80](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-collection.ts#L80)
-
-## Parameters
-
-### x
-
-[`LedgerItem`](../../ledger-item/classes/LedgerItem.md)
-
-### index
-
-`number`
-
-## Returns
-
-`boolean`

package/docs/ledger/ledger-item/classes/LedgerItem.md

@@ -1,211 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [ledger/ledger-item](../index.md) / LedgerItem
-
-# Class: LedgerItem
-
-Defined in: [ledger/ledger-item.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L7)
-
-this is an entry into the account. Think of it as a checking account, and it's simply a transaction line.
-
-## Constructors
-
-### new LedgerItem()
-
-> **new LedgerItem**(`amount`?, `type`?, `created`?, `note`?): [`LedgerItem`](LedgerItem.md)
-
-Defined in: [ledger/ledger-item.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L13)
-
-#### Parameters
-
-##### amount?
-
-`number`
-
-##### type?
-
-[`LedgerItemType`](../../ledger-item-type/enumerations/LedgerItemType.md)
-
-##### created?
-
-`Date`
-
-##### note?
-
-`string`
-
-#### Returns
-
-[`LedgerItem`](LedgerItem.md)
-
-## Properties
-
-### amount
-
-> **amount**: `number` = `0`
-
-Defined in: [ledger/ledger-item.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L10)
-
----
-
-### created?
-
-> `optional` **created**: `Date`
-
-Defined in: [ledger/ledger-item.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L9)
-
----
-
-### note?
-
-> `optional` **note**: `string`
-
-Defined in: [ledger/ledger-item.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L11)
-
----
-
-### type
-
-> **type**: [`LedgerItemType`](../../ledger-item-type/enumerations/LedgerItemType.md)
-
-Defined in: [ledger/ledger-item.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L8)
-
-## Methods
-
-### clone()
-
-> **clone**(): [`LedgerItem`](LedgerItem.md)
-
-Defined in: [ledger/ledger-item.ts:86](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L86)
-
-#### Returns
-
-[`LedgerItem`](LedgerItem.md)
-
----
-
-### dateLessThanOrEqualTo()
-
-> **dateLessThanOrEqualTo**(`today`): `boolean`
-
-Defined in: [ledger/ledger-item.ts:50](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L50)
-
-#### Parameters
-
-##### today
-
-`Date`
-
-#### Returns
-
-`boolean`
-
----
-
-### dateMatchesYear()
-
-> **dateMatchesYear**(`year`): `boolean`
-
-Defined in: [ledger/ledger-item.ts:66](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L66)
-
-#### Parameters
-
-##### year
-
-`number`
-
-#### Returns
-
-`boolean`
-
----
-
-### dateMatchesYearAndMonth()
-
-> **dateMatchesYearAndMonth**(`today`): `boolean`
-
-Defined in: [ledger/ledger-item.ts:38](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L38)
-
-#### Parameters
-
-##### today
-
-`Date`
-
-#### Returns
-
-`boolean`
-
----
-
-### dateNotGreaterThan()
-
-> **dateNotGreaterThan**(`today`): `boolean`
-
-Defined in: [ledger/ledger-item.ts:58](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L58)
-
-#### Parameters
-
-##### today
-
-`Date`
-
-#### Returns
-
-`boolean`
-
----
-
-### getMonth()
-
-> **getMonth**(): `number`
-
-Defined in: [ledger/ledger-item.ts:26](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L26)
-
-#### Returns
-
-`number`
-
----
-
-### getYear()
-
-> **getYear**(): `number`
-
-Defined in: [ledger/ledger-item.ts:78](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L78)
-
-#### Returns
-
-`number`
-
----
-
-### isAmountGreaterThanZero()
-
-> **isAmountGreaterThanZero**(): `boolean`
-
-Defined in: [ledger/ledger-item.ts:34](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L34)
-
-#### Returns
-
-`boolean`
-
----
-
-### typeMatches()
-
-> **typeMatches**(`itemType`): `boolean`
-
-Defined in: [ledger/ledger-item.ts:74](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item.ts#L74)
-
-#### Parameters
-
-##### itemType
-
-[`LedgerItemType`](../../ledger-item-type/enumerations/LedgerItemType.md)
-
-#### Returns
-
-`boolean`

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

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / ledger/ledger-item
-
-# ledger/ledger-item
-
-## Classes
-
-- [LedgerItem](classes/LedgerItem.md)

package/docs/ledger/ledger-item-type/enumerations/LedgerItemType.md

@@ -1,57 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [ledger/ledger-item-type](../index.md) / LedgerItemType
-
-# Enumeration: LedgerItemType
-
-Defined in: [ledger/ledger-item-type.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item-type.ts#L1)
-
-## Enumeration Members
-
-### CashFlow
-
-> **CashFlow**: `"Cash Flow"`
-
-Defined in: [ledger/ledger-item-type.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item-type.ts#L3)
-
----
-
-### Equity
-
-> **Equity**: `"Equity Capture"`
-
-Defined in: [ledger/ledger-item-type.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item-type.ts#L7)
-
----
-
-### Misc
-
-> **Misc**: `"Misc"`
-
-Defined in: [ledger/ledger-item-type.ts:2](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item-type.ts#L2)
-
----
-
-### Purchase
-
-> **Purchase**: `"Purchase"`
-
-Defined in: [ledger/ledger-item-type.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item-type.ts#L6)
-
----
-
-### Salary
-
-> **Salary**: `"Salary Savings"`
-
-Defined in: [ledger/ledger-item-type.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item-type.ts#L4)
-
----
-
-### Saved
-
-> **Saved**: `"Saved Up"`
-
-Defined in: [ledger/ledger-item-type.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/ledger/ledger-item-type.ts#L5)

package/docs/ledger/ledger-item-type/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / ledger/ledger-item-type
-
-# ledger/ledger-item-type
-
-## Enumerations
-
-- [LedgerItemType](enumerations/LedgerItemType.md)

package/docs/loans/i-loan-settings/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / loans/i-loan-settings
-
-# loans/i-loan-settings
-
-## Interfaces
-
-- [ILoanSetting](interfaces/ILoanSetting.md)

package/docs/loans/i-loan-settings/interfaces/ILoanSetting.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [loans/i-loan-settings](../index.md) / ILoanSetting
-
-# Interface: ILoanSetting
-
-Defined in: [loans/i-loan-settings.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/i-loan-settings.ts#L4)
-
-## Properties
-
-### name
-
-> **name**: [`LoanSettings`](../../loan-settings/enumerations/LoanSettings.md)
-
-Defined in: [loans/i-loan-settings.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/i-loan-settings.ts#L6)
-
----
-
-### propertyType
-
-> **propertyType**: [`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
-
-Defined in: [loans/i-loan-settings.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/i-loan-settings.ts#L5)
-
----
-
-### value
-
-> **value**: `number`
-
-Defined in: [loans/i-loan-settings.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/i-loan-settings.ts#L7)

package/docs/loans/index.md

@@ -1,19 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../modules.md) / loans
-
-# loans
-
-## References
-
-### ILoanSetting
-
-Re-exports [ILoanSetting](i-loan-settings/interfaces/ILoanSetting.md)
-
----
-
-### LoanSettings
-
-Re-exports [LoanSettings](loan-settings/enumerations/LoanSettings.md)