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

package/docs/calculations/get-monthly-mortgage/functions/getMonthlyMortgage.md

@@ -1,43 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-monthly-mortgage](../index.md) / getMonthlyMortgage
-
-# Function: getMonthlyMortgage()
-
-> **getMonthlyMortgage**(`purchasePrice`, `cashDownPercent`, `closingCostPercent`, `loanRatePercent`, `loanTermInYears`): `number`
-
-Defined in: [calculations/get-monthly-mortgage.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-monthly-mortgage.ts#L12)
-
-formula for M = P [ i(1 + i)^n ] / [ (1 + i)^n – 1].
-
-## Parameters
-
-### purchasePrice
-
-`number`
-
-### cashDownPercent
-
-`number`
-
-### closingCostPercent
-
-`number`
-
-### loanRatePercent
-
-`number`
-
-annual percentage rate of your loan, like 3.25%
-
-### loanTermInYears
-
-`number` = `30`
-
-15 or 30 typically
-
-## Returns
-
-`number`

package/docs/calculations/get-monthly-mortgage/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/get-monthly-mortgage
-
-# calculations/get-monthly-mortgage
-
-## Functions
-
-- [getMonthlyMortgage](functions/getMonthlyMortgage.md)

package/docs/calculations/get-monthly-principal-interest-tax-interest/functions/getMonthlyPrincipalInterestTaxInterest.md

@@ -1,43 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-monthly-principal-interest-tax-interest](../index.md) / getMonthlyPrincipalInterestTaxInterest
-
-# Function: getMonthlyPrincipalInterestTaxInterest()
-
-> **getMonthlyPrincipalInterestTaxInterest**(`purchasePrice`, `cashDownPercent`, `closingCostPercent`, `loanRatePercent`, `loanTermInYears`): `number`
-
-Defined in: [calculations/get-monthly-principal-interest-tax-interest.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-monthly-principal-interest-tax-interest.ts#L12)
-
-This gets you PITI!
-
-## Parameters
-
-### purchasePrice
-
-`number`
-
-### cashDownPercent
-
-`number`
-
-### closingCostPercent
-
-`number`
-
-### loanRatePercent
-
-`number`
-
-annual percentage rate of your loan, like 3.25%
-
-### loanTermInYears
-
-`number` = `30`
-
-15 or 30 typically
-
-## Returns
-
-`number`

package/docs/calculations/get-monthly-principal-interest-tax-interest/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/get-monthly-principal-interest-tax-interest
-
-# calculations/get-monthly-principal-interest-tax-interest
-
-## Functions
-
-- [getMonthlyPrincipalInterestTaxInterest](functions/getMonthlyPrincipalInterestTaxInterest.md)

package/docs/calculations/get-sell-price-estimate/functions/getSellPriceEstimate.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-sell-price-estimate](../index.md) / getSellPriceEstimate
-
-# Function: getSellPriceEstimate()
-
-> **getSellPriceEstimate**(`purchase`, `sell`, `purchasePrice`, `sellPriceAppreciationPercent`): `number`
-
-Defined in: [calculations/get-sell-price-estimate.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-sell-price-estimate.ts#L4)
-
-## Parameters
-
-### purchase
-
-`Date`
-
-### sell
-
-`Date`
-
-### purchasePrice
-
-`number`
-
-### sellPriceAppreciationPercent
-
-`number`
-
-## Returns
-
-`number`

package/docs/calculations/get-sell-price-estimate/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/get-sell-price-estimate
-
-# calculations/get-sell-price-estimate
-
-## Functions
-
-- [getSellPriceEstimate](functions/getSellPriceEstimate.md)

package/docs/calculations/index.md

@@ -1,73 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../modules.md) / calculations
-
-# calculations
-
-## References
-
-### canInvestByUser
-
-Re-exports [canInvestByUser](can-invest-by-user/functions/canInvestByUser.md)
-
----
-
-### cashOnCashReturn
-
-Re-exports [cashOnCashReturn](cash-on-cash-return/functions/cashOnCashReturn.md)
-
----
-
-### getCostDown
-
-Re-exports [getCostDown](get-cost-down/functions/getCostDown.md)
-
----
-
-### getCostDownUserInvestmentResults
-
-Re-exports [getCostDownUserInvestmentResults](get-cost-down-user-investment-results/functions/getCostDownUserInvestmentResults.md)
-
----
-
-### getEquityCaptureAmount
-
-Re-exports [getEquityCaptureAmount](get-equity-capture-amount/functions/getEquityCaptureAmount.md)
-
----
-
-### getEquityCaptureUserInvestmentResults
-
-Re-exports [getEquityCaptureUserInvestmentResults](get-equity-capture-user-investment-results/functions/getEquityCaptureUserInvestmentResults.md)
-
----
-
-### getInvestmentPercent
-
-Re-exports [getInvestmentPercent](get-investment-percent/functions/getInvestmentPercent.md)
-
----
-
-### getMonthlyMortgage
-
-Re-exports [getMonthlyMortgage](get-monthly-mortgage/functions/getMonthlyMortgage.md)
-
----
-
-### getMonthlyPrincipalInterestTaxInterest
-
-Re-exports [getMonthlyPrincipalInterestTaxInterest](get-monthly-principal-interest-tax-interest/functions/getMonthlyPrincipalInterestTaxInterest.md)
-
----
-
-### getSellPriceEstimate
-
-Re-exports [getSellPriceEstimate](get-sell-price-estimate/functions/getSellPriceEstimate.md)
-
----
-
-### returnOnCapitalGain
-
-Re-exports [returnOnCapitalGain](return-on-capital-gain/functions/returnOnCapitalGain.md)

package/docs/calculations/return-on-capital-gain/functions/returnOnCapitalGain.md

@@ -1,31 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/return-on-capital-gain](../index.md) / returnOnCapitalGain
-
-# Function: returnOnCapitalGain()
-
-> **returnOnCapitalGain**(`unrealizedCapitalGain`, `costDownPrice`): `number`
-
-Defined in: [calculations/return-on-capital-gain.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/return-on-capital-gain.ts#L9)
-
-takes unrealized capital gain (equity or profit from sell) and divides it against cash down to determine return on capital gain
-
-## Parameters
-
-### unrealizedCapitalGain
-
-`number`
-
-currently equity is subbed in. In actuality it's potential money gained from the sale of a property
-
-### costDownPrice
-
-`number`
-
-## Returns
-
-`number`
-
-returns a percentage value XX.XX%

package/docs/calculations/return-on-capital-gain/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/return-on-capital-gain
-
-# calculations/return-on-capital-gain
-
-## Functions
-
-- [returnOnCapitalGain](functions/returnOnCapitalGain.md)

package/docs/formatters/currency/functions/default.md

@@ -1,21 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [formatters/currency](../index.md) / default
-
-# Function: default()
-
-> **default**(`value`): `number`
-
-Defined in: [formatters/currency.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/formatters/currency.ts#L1)
-
-## Parameters
-
-### value
-
-`number`
-
-## Returns
-
-`number`

package/docs/formatters/currency/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / formatters/currency
-
-# formatters/currency
-
-## Functions
-
-- [default](functions/default.md)

package/docs/formatters/index.md

@@ -1,7 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../modules.md) / formatters
-
-# formatters

package/docs/generators/factory-passive-apartment/functions/generateRentalPassiveApartment.md

@@ -1,35 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [generators/factory-passive-apartment](../index.md) / generateRentalPassiveApartment
-
-# Function: generateRentalPassiveApartment()
-
-> **generateRentalPassiveApartment**(`options`, `lifeTime`, `userSettings`, `closingCostPercent`): [`RentalPassiveApartment`](../../../properties/rental-passive-apartment/classes/RentalPassiveApartment.md)
-
-Defined in: [generators/factory-passive-apartment.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/factory-passive-apartment.ts#L13)
-
-used to provide exclusive info for generating a [RentalPassiveApartment](../../../properties/rental-passive-apartment/classes/RentalPassiveApartment.md)
-
-## Parameters
-
-### options
-
-[`IPropertyEntityOptions`](../../i-property-entity-options/interfaces/IPropertyEntityOptions.md)
-
-### lifeTime
-
-[`IEntityExistence`](../../../properties/i-entity-existence/interfaces/IEntityExistence.md)
-
-### userSettings
-
-[`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]
-
-### closingCostPercent
-
-`number`
-
-## Returns
-
-[`RentalPassiveApartment`](../../../properties/rental-passive-apartment/classes/RentalPassiveApartment.md)

package/docs/generators/factory-passive-apartment/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / generators/factory-passive-apartment
-
-# generators/factory-passive-apartment
-
-## Functions
-
-- [generateRentalPassiveApartment](functions/generateRentalPassiveApartment.md)

package/docs/generators/factory-single-family/functions/generateSingleFamily.md

@@ -1,35 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [generators/factory-single-family](../index.md) / generateSingleFamily
-
-# Function: generateSingleFamily()
-
-> **generateSingleFamily**(`options`, `lifeTime`, `userSettings`, `closingCostPercent`): [`RentalSingleFamily`](../../../properties/rental-single-family/classes/RentalSingleFamily.md)
-
-Defined in: [generators/factory-single-family.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/factory-single-family.ts#L18)
-
-used to provide exclusive info for generating a [RentalSingleFamily](../../../properties/rental-single-family/classes/RentalSingleFamily.md)
-
-## Parameters
-
-### options
-
-[`IPropertyEntityOptions`](../../i-property-entity-options/interfaces/IPropertyEntityOptions.md)
-
-### lifeTime
-
-[`IEntityExistence`](../../../properties/i-entity-existence/interfaces/IEntityExistence.md)
-
-### userSettings
-
-[`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]
-
-### closingCostPercent
-
-`number`
-
-## Returns
-
-[`RentalSingleFamily`](../../../properties/rental-single-family/classes/RentalSingleFamily.md)

package/docs/generators/factory-single-family/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / generators/factory-single-family
-
-# generators/factory-single-family
-
-## Functions
-
-- [generateSingleFamily](functions/generateSingleFamily.md)

package/docs/generators/generate-property/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / generators/generate-property
-
-# generators/generate-property
-
-## Type Aliases
-
-- [GenerateProperty](type-aliases/GenerateProperty.md)

package/docs/generators/generate-property/type-aliases/GenerateProperty.md

@@ -1,37 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [generators/generate-property](../index.md) / GenerateProperty
-
-# Type Alias: GenerateProperty()\<T\>
-
-> **GenerateProperty**\<`T`\>: (`options`, `lifeTime`, `userSettings`, `closingCostPercent`) => `T`
-
-Defined in: [generators/generate-property.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/generate-property.ts#L5)
-
-## Type Parameters
-
-• **T** _extends_ [`IPropertyEntity`](../../../properties/i-property-entity/interfaces/IPropertyEntity.md)
-
-## Parameters
-
-### options
-
-[`IPropertyEntityOptions`](../../i-property-entity-options/interfaces/IPropertyEntityOptions.md)
-
-### lifeTime
-
-[`IEntityExistence`](../../../properties/i-entity-existence/interfaces/IEntityExistence.md)
-
-### userSettings
-
-[`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]
-
-### closingCostPercent
-
-`number`
-
-## Returns
-
-`T`

package/docs/generators/generic-generate-property/functions/genericGenerateProperty.md

@@ -1,35 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [generators/generic-generate-property](../index.md) / genericGenerateProperty
-
-# Function: genericGenerateProperty()
-
-> **genericGenerateProperty**\<`T`\>(`rentalClassType`, `options`, `lifeTime`): `T`
-
-Defined in: [generators/generic-generate-property.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/generic-generate-property.ts#L11)
-
-used to dynamically create a rental and hydrate it
-
-## Type Parameters
-
-• **T** _extends_ [`IPropertyEntity`](../../../properties/i-property-entity/interfaces/IPropertyEntity.md)
-
-## Parameters
-
-### rentalClassType
-
-() => `T`
-
-### options
-
-[`IPropertyEntityOptions`](../../i-property-entity-options/interfaces/IPropertyEntityOptions.md)
-
-### lifeTime
-
-[`IEntityExistence`](../../../properties/i-entity-existence/interfaces/IEntityExistence.md)
-
-## Returns
-
-`T`

package/docs/generators/generic-generate-property/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / generators/generic-generate-property
-
-# generators/generic-generate-property
-
-## Functions
-
-- [genericGenerateProperty](functions/genericGenerateProperty.md)

package/docs/generators/i-property-entity-options/index.md

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

package/docs/generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md

@@ -1,113 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [generators/i-property-entity-options](../index.md) / IPropertyEntityOptions
-
-# Interface: IPropertyEntityOptions
-
-Defined in: [generators/i-property-entity-options.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L1)
-
-## Extended by
-
-- [`IGenOptions`](../../../time/simulate/interfaces/IGenOptions.md)
-
-## Properties
-
-### highestCashFlow
-
-> **highestCashFlow**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:40](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L40)
-
-I've seen as high as 630 a month, but on average, depending on the area, I've seen 450 a month
-
----
-
-### highestEquityCapturePercent
-
-> **highestEquityCapturePercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:20](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L20)
-
-used to generate a random equity amount, this is the high value
-
----
-
-### highestMinSellInYears
-
-> **highestMinSellInYears**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:50](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L50)
-
-For Texas, you should hold for 1 year for the lowest tax rate, but you might want to hold it longer
-
----
-
-### highestPurchasePrice
-
-> **highestPurchasePrice**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L10)
-
-used to generate a random price amount, this is the high value
-
----
-
-### highestSellAppreciationPercent
-
-> **highestSellAppreciationPercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:30](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L30)
-
-for single family it is as high as 14.5 %
-
----
-
-### lowestCashFlow
-
-> **lowestCashFlow**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:35](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L35)
-
-typically 200 is the lowest
-
----
-
-### lowestEquityCapturePercent
-
-> **lowestEquityCapturePercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:15](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L15)
-
-used to generate a random equity amount, this is the low value
-
----
-
-### lowestMinSellInYears
-
-> **lowestMinSellInYears**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:45](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L45)
-
-For Texas, you should hold for 1 year for the lowest tax rate, but you might want to hold it longer
-
----
-
-### lowestPurchasePrice
-
-> **lowestPurchasePrice**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L5)
-
-used to generate a random price amount, this is the low value
-
----
-
-### lowestSellAppreciationPercent
-
-> **lowestSellAppreciationPercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:25](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L25)
-
-for single family it's around 4%