@cubedelement.com/realty-investor-timeline 5.5.0 → 5.6.0

package/docs/loans/loan-settings/enumerations/LoanSettings.md

@@ -1,41 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [loans/loan-settings](../index.md) / LoanSettings
-
-# Enumeration: LoanSettings
-
-Defined in: [loans/loan-settings.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/loan-settings.ts#L4)
-
-Loan Settings
-
-## Enumeration Members
-
-### LoanRatePercent
-
-> **LoanRatePercent**: `0`
-
-Defined in: [loans/loan-settings.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/loan-settings.ts#L8)
-
-Loan Rate Percent
-
----
-
-### LoanTermInYears
-
-> **LoanTermInYears**: `1`
-
-Defined in: [loans/loan-settings.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/loan-settings.ts#L13)
-
-Loan Terms in Years
-
----
-
-### MinimumMonthlyReservesForRental
-
-> **MinimumMonthlyReservesForRental**: `2`
-
-Defined in: [loans/loan-settings.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/loans/loan-settings.ts#L18)
-
-Minimum Monthly Reserves for Rental

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

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / loans/loan-settings
-
-# loans/loan-settings
-
-## Enumerations
-
-- [LoanSettings](enumerations/LoanSettings.md)

package/docs/modules.md

@@ -1,88 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](index.md)
-
----
-
-# @cubedelement.com/realty-investor-timeline
-
-## Modules
-
-- [account](account/index.md)
-- [account/i-user-goal](account/i-user-goal/index.md)
-- [account/i-user-investor-check](account/i-user-investor-check/index.md)
-- [account/user](account/user/index.md)
-- [caching](caching/index.md)
-- [caching/value-cache](caching/value-cache/index.md)
-- [calculations](calculations/index.md)
-- [calculations/can-invest-by-user](calculations/can-invest-by-user/index.md)
-- [calculations/cash-on-cash-return](calculations/cash-on-cash-return/index.md)
-- [calculations/get-cost-down](calculations/get-cost-down/index.md)
-- [calculations/get-cost-down-user-investment-results](calculations/get-cost-down-user-investment-results/index.md)
-- [calculations/get-equity-capture-amount](calculations/get-equity-capture-amount/index.md)
-- [calculations/get-equity-capture-user-investment-results](calculations/get-equity-capture-user-investment-results/index.md)
-- [calculations/get-investment-percent](calculations/get-investment-percent/index.md)
-- [calculations/get-min-cost-down-by-rule](calculations/get-min-cost-down-by-rule/index.md)
-- [calculations/get-monthly-mortgage](calculations/get-monthly-mortgage/index.md)
-- [calculations/get-monthly-principal-interest-tax-interest](calculations/get-monthly-principal-interest-tax-interest/index.md)
-- [calculations/get-sell-price-estimate](calculations/get-sell-price-estimate/index.md)
-- [calculations/return-on-capital-gain](calculations/return-on-capital-gain/index.md)
-- [formatters](formatters/index.md)
-- [formatters/currency](formatters/currency/index.md)
-- [generators](generators/index.md)
-- [generators/factory-passive-apartment](generators/factory-passive-apartment/index.md)
-- [generators/factory-single-family](generators/factory-single-family/index.md)
-- [generators/generate-property](generators/generate-property/index.md)
-- [generators/generic-generate-property](generators/generic-generate-property/index.md)
-- [generators/i-property-entity-options](generators/i-property-entity-options/index.md)
-- [generators/rental-generator](generators/rental-generator/index.md)
-- [index](index/index.md)
-- [investments](investments/index.md)
-- [investments/investment-reasons](investments/investment-reasons/index.md)
-- [investments/investment-reasons-decorator](investments/investment-reasons-decorator/index.md)
-- [investments/reason-to-rule](investments/reason-to-rule/index.md)
-- [investments/rental-investor-validator](investments/rental-investor-validator/index.md)
-- [investments/user-invest-result](investments/user-invest-result/index.md)
-- [investments/user-result-estimates](investments/user-result-estimates/index.md)
-- [ledger](ledger/index.md)
-- [ledger/i-ledger-summary](ledger/i-ledger-summary/index.md)
-- [ledger/ledger-collection](ledger/ledger-collection/index.md)
-- [ledger/ledger-item](ledger/ledger-item/index.md)
-- [ledger/ledger-item-type](ledger/ledger-item-type/index.md)
-- [loans](loans/index.md)
-- [loans/i-loan-settings](loans/i-loan-settings/index.md)
-- [loans/loan-settings](loans/loan-settings/index.md)
-- [properties](properties/index.md)
-- [properties/i-entity-existence](properties/i-entity-existence/index.md)
-- [properties/i-property-entity](properties/i-property-entity/index.md)
-- [properties/i-rental-property-entity](properties/i-rental-property-entity/index.md)
-- [properties/property-sort](properties/property-sort/index.md)
-- [properties/property-type](properties/property-type/index.md)
-- [properties/rental-passive-apartment](properties/rental-passive-apartment/index.md)
-- [properties/rental-single-family](properties/rental-single-family/index.md)
-- [rules](rules/index.md)
-- [rules/eval-type](rules/eval-type/index.md)
-- [rules/eval-types](rules/eval-types/index.md)
-- [rules/get-enum-type-by-value](rules/get-enum-type-by-value/index.md)
-- [rules/get-rules](rules/get-rules/index.md)
-- [rules/hold-rule-types](rules/hold-rule-types/index.md)
-- [rules/i-rule](rules/i-rule/index.md)
-- [rules/purchase-rule-types](rules/purchase-rule-types/index.md)
-- [rules/rule-evaluation](rules/rule-evaluation/index.md)
-- [time](time/index.md)
-- [time/default-has-met-goal-or-max-time](time/default-has-met-goal-or-max-time/index.md)
-- [time/has-met-goal-or-max-time](time/has-met-goal-or-max-time/index.md)
-- [time/i-historical-property](time/i-historical-property/index.md)
-- [time/i-historical-reason](time/i-historical-reason/index.md)
-- [time/i-loop-options](time/i-loop-options/index.md)
-- [time/i-loop-recursive-options](time/i-loop-recursive-options/index.md)
-- [time/looper](time/looper/index.md)
-- [time/movement](time/movement/index.md)
-- [time/simulate](time/simulate/index.md)
-- [time/timeline](time/timeline/index.md)
-- [time/update-historical-rentals](time/update-historical-rentals/index.md)
-- [utils](utils/index.md)
-- [utils/data-are-same-date](utils/data-are-same-date/index.md)
-- [utils/data-clone-date](utils/data-clone-date/index.md)
-- [utils/data-compare-date](utils/data-compare-date/index.md)
-- [utils/data-number](utils/data-number/index.md)
-- [utils/data-property-entity](utils/data-property-entity/index.md)
-- [utils/ensure](utils/ensure/index.md)

package/docs/properties/i-entity-existence/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / properties/i-entity-existence
-
-# properties/i-entity-existence
-
-## Interfaces
-
-- [IEntityExistence](interfaces/IEntityExistence.md)

package/docs/properties/i-entity-existence/interfaces/IEntityExistence.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [properties/i-entity-existence](../index.md) / IEntityExistence
-
-# Interface: IEntityExistence
-
-Defined in: [properties/i-entity-existence.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-entity-existence.ts#L1)
-
-## Extended by
-
-- [`IPropertyEntity`](../../i-property-entity/interfaces/IPropertyEntity.md)
-
-## Properties
-
-### availableEndDate
-
-> **availableEndDate**: `Date`
-
-Defined in: [properties/i-entity-existence.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-entity-existence.ts#L9)
-
-date which property was removed from the timeline.. think of it like someone else purchased this property
-
----
-
-### availableStartDate
-
-> **availableStartDate**: `Date`
-
-Defined in: [properties/i-entity-existence.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-entity-existence.ts#L5)
-
-date which property was generated or was available for purchase

package/docs/properties/i-property-entity/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / properties/i-property-entity
-
-# properties/i-property-entity
-
-## Interfaces
-
-- [IPropertyEntity](interfaces/IPropertyEntity.md)

package/docs/properties/i-property-entity/interfaces/IPropertyEntity.md

@@ -1,159 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [properties/i-property-entity](../index.md) / IPropertyEntity
-
-# Interface: IPropertyEntity
-
-Defined in: [properties/i-property-entity.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L4)
-
-## Extends
-
-- [`IEntityExistence`](../../i-entity-existence/interfaces/IEntityExistence.md)
-
-## Extended by
-
-- [`IRentalPropertyEntity`](../../i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-## Properties
-
-### address
-
-> **address**: `string`
-
-Defined in: [properties/i-property-entity.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L13)
-
-address of property
-
----
-
-### availableEndDate
-
-> **availableEndDate**: `Date`
-
-Defined in: [properties/i-entity-existence.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-entity-existence.ts#L9)
-
-date which property was removed from the timeline.. think of it like someone else purchased this property
-
-#### Inherited from
-
-[`IEntityExistence`](../../i-entity-existence/interfaces/IEntityExistence.md).[`availableEndDate`](../../i-entity-existence/interfaces/IEntityExistence.md#availableenddate)
-
----
-
-### availableStartDate
-
-> **availableStartDate**: `Date`
-
-Defined in: [properties/i-entity-existence.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-entity-existence.ts#L5)
-
-date which property was generated or was available for purchase
-
-#### Inherited from
-
-[`IEntityExistence`](../../i-entity-existence/interfaces/IEntityExistence.md).[`availableStartDate`](../../i-entity-existence/interfaces/IEntityExistence.md#availablestartdate)
-
----
-
-### costDownPrice
-
-> **costDownPrice**: `number`
-
-Defined in: [properties/i-property-entity.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L23)
-
-it's the purchase down
-
----
-
-### equityCapturePercent
-
-> **equityCapturePercent**: `number`
-
-Defined in: [properties/i-property-entity.ts:50](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L50)
-
-this can be between 10 - 20%
-
----
-
-### id
-
-> **id**: `string`
-
-Defined in: [properties/i-property-entity.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L8)
-
-unique identifier
-
----
-
-### minSellYears?
-
-> `optional` **minSellYears**: `number`
-
-Defined in: [properties/i-property-entity.ts:35](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L35)
-
-number of years to hold the property before being sold
-
----
-
-### offeredInvestmentAmounts
-
-> **offeredInvestmentAmounts**: `number`[]
-
-Defined in: [properties/i-property-entity.ts:25](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L25)
-
----
-
-### propertyType
-
-> `readonly` **propertyType**: [`PropertyType`](../../property-type/enumerations/PropertyType.md)
-
-Defined in: [properties/i-property-entity.ts:55](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L55)
-
-used when evaluating rules
-
----
-
-### purchasePrice
-
-> **purchasePrice**: `number`
-
-Defined in: [properties/i-property-entity.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L18)
-
-purchase price of the property (may or may not be after repair value, ARV)
-
----
-
-### rawCashFlow
-
-> **rawCashFlow**: `number`
-
-Defined in: [properties/i-property-entity.ts:40](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L40)
-
-the cashOnCash return
-
----
-
-### sellPriceAppreciationPercent
-
-> **sellPriceAppreciationPercent**: `number`
-
-Defined in: [properties/i-property-entity.ts:30](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L30)
-
-the percent at which the property's value grows
-
-## Accessors
-
-### rawEstimatedAnnualCashFlow
-
-#### Get Signature
-
-> **get** **rawEstimatedAnnualCashFlow**(): `number`
-
-Defined in: [properties/i-property-entity.ts:45](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/properties/i-property-entity.ts#L45)
-
-the estimated annual cashFlow return
-
-##### Returns
-
-`number`

package/docs/properties/i-rental-property-entity/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / properties/i-rental-property-entity
-
-# properties/i-rental-property-entity
-
-## Interfaces
-
-- [IRentalPropertyEntity](interfaces/IRentalPropertyEntity.md)