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

package/docs/caching/value-cache/classes/ValueCache.md

@@ -1,194 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [caching/value-cache](../index.md) / ValueCache
-
-# Class: ValueCache\<T\>
-
-Defined in: [caching/value-cache.ts:34](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L34)
-
-## Type Parameters
-
-• **T**
-
-## Implements
-
-- [`IValueCache`](../interfaces/IValueCache.md)\<`T`\>
-
-## Constructors
-
-### new ValueCache()
-
-> **new ValueCache**\<`T`\>(`expireDate`, `defaultValue`, `renewalInMonths`): [`ValueCache`](ValueCache.md)\<`T`\>
-
-Defined in: [caching/value-cache.ts:56](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L56)
-
-#### Parameters
-
-##### expireDate
-
-`Date`
-
-##### defaultValue
-
-`T`[]
-
-##### renewalInMonths
-
-`number`
-
-#### Returns
-
-[`ValueCache`](ValueCache.md)\<`T`\>
-
-## Properties
-
-### \_value
-
-> `protected` **\_value**: `T`[]
-
-Defined in: [caching/value-cache.ts:106](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L106)
-
----
-
-### renewalInMonths
-
-> **renewalInMonths**: `number`
-
-Defined in: [caching/value-cache.ts:35](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L35)
-
-#### Implementation of
-
-[`IValueCache`](../interfaces/IValueCache.md).[`renewalInMonths`](../interfaces/IValueCache.md#renewalinmonths)
-
-## Accessors
-
-### expireDate
-
-#### Get Signature
-
-> **get** **expireDate**(): `Date`
-
-Defined in: [caching/value-cache.ts:37](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L37)
-
-##### Returns
-
-`Date`
-
-#### Set Signature
-
-> **set** **expireDate**(`value`): `void`
-
-Defined in: [caching/value-cache.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L41)
-
-##### Parameters
-
-###### value
-
-`Date`
-
-##### Returns
-
-`void`
-
-#### Implementation of
-
-[`IValueCache`](../interfaces/IValueCache.md).[`expireDate`](../interfaces/IValueCache.md#expiredate)
-
----
-
-### newDefault
-
-#### Get Signature
-
-> **get** **newDefault**(): `T`[]
-
-Defined in: [caching/value-cache.ts:48](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L48)
-
-##### Returns
-
-`T`[]
-
-#### Implementation of
-
-[`IValueCache`](../interfaces/IValueCache.md).[`newDefault`](../interfaces/IValueCache.md#newdefault)
-
-## Methods
-
-### getValue()
-
-> **getValue**(`currentTime`): `T`[]
-
-Defined in: [caching/value-cache.ts:76](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L76)
-
-if the cache is expired, then it will return the default value. otherwise
-it will return the stored value
-
-#### Parameters
-
-##### currentTime
-
-`Date`
-
-#### Returns
-
-`T`[]
-
-#### Implementation of
-
-[`IValueCache`](../interfaces/IValueCache.md).[`getValue`](../interfaces/IValueCache.md#getvalue)
-
----
-
-### isCacheExpired()
-
-> **isCacheExpired**(`currentDate`?): `boolean`
-
-Defined in: [caching/value-cache.ts:94](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L94)
-
-determines if the expiredDate is greater than
-or equal to currentDate. if this is the case it
-will be return true. Also if expiredDate is nothing,
-then it will return true. Also if currentDate is null,
-while expiredDate exists then it will be expired, aka true
-
-#### Parameters
-
-##### currentDate?
-
-`Date`
-
-#### Returns
-
-`boolean`
-
-#### Implementation of
-
-[`IValueCache`](../interfaces/IValueCache.md).[`isCacheExpired`](../interfaces/IValueCache.md#iscacheexpired)
-
----
-
-### setValue()
-
-> **setValue**(`value`, `currentDate`): `void`
-
-Defined in: [caching/value-cache.ts:63](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L63)
-
-#### Parameters
-
-##### value
-
-`T`[]
-
-##### currentDate
-
-`Date`
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`IValueCache`](../interfaces/IValueCache.md).[`setValue`](../interfaces/IValueCache.md#setvalue)

package/docs/caching/value-cache/index.md

@@ -1,15 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / caching/value-cache
-
-# caching/value-cache
-
-## Classes
-
-- [ValueCache](classes/ValueCache.md)
-
-## Interfaces
-
-- [IValueCache](interfaces/IValueCache.md)

package/docs/caching/value-cache/interfaces/IValueCache.md

@@ -1,104 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [caching/value-cache](../index.md) / IValueCache
-
-# Interface: IValueCache\<T\>
-
-Defined in: [caching/value-cache.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L9)
-
-## Type Parameters
-
-• **T**
-
-## Properties
-
-### expireDate
-
-> **expireDate**: `Date`
-
-Defined in: [caching/value-cache.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L11)
-
----
-
-### newDefault
-
-> `readonly` **newDefault**: `unknown`
-
-Defined in: [caching/value-cache.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L12)
-
----
-
-### renewalInMonths
-
-> **renewalInMonths**: `number`
-
-Defined in: [caching/value-cache.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L10)
-
-## Methods
-
-### getValue()
-
-> **getValue**(`currentTime`): `T`[]
-
-Defined in: [caching/value-cache.ts:20](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L20)
-
-if the cache is expired, then it will return the default value. otherwise
-it will return the stored value
-
-#### Parameters
-
-##### currentTime
-
-`Date`
-
-#### Returns
-
-`T`[]
-
----
-
-### isCacheExpired()
-
-> **isCacheExpired**(`currentDate`?): `boolean`
-
-Defined in: [caching/value-cache.ts:31](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L31)
-
-determines if the expiredDate is greater than
-or equal to currentDate. if this is the case it
-will be return true. Also if expiredDate is nothing,
-then it will return true. Also if currentDate is null,
-while expiredDate exists then it will be expired, aka true
-
-#### Parameters
-
-##### currentDate?
-
-`Date`
-
-#### Returns
-
-`boolean`
-
----
-
-### setValue()
-
-> **setValue**(`value`, `currentDate`): `void`
-
-Defined in: [caching/value-cache.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/caching/value-cache.ts#L14)
-
-#### Parameters
-
-##### value
-
-`T`[]
-
-##### currentDate
-
-`Date`
-
-#### Returns
-
-`void`

package/docs/calculations/can-invest-by-user/functions/canInvestByUser.md

@@ -1,35 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/can-invest-by-user](../index.md) / canInvestByUser
-
-# Function: canInvestByUser()
-
-> **canInvestByUser**(`rental`, `user`, `date`, `properties`): [`IRentalInvestorValidator`](../../../investments/rental-investor-validator/interfaces/IRentalInvestorValidator.md)
-
-Defined in: [calculations/can-invest-by-user.ts:16](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/can-invest-by-user.ts#L16)
-
-determines if a user can invest in a property.
-
-## Parameters
-
-### rental
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-### user
-
-[`IUserInvestorCheck`](../../../account/i-user-investor-check/interfaces/IUserInvestorCheck.md)
-
-### date
-
-`Date`
-
-### properties
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
-
-## Returns
-
-[`IRentalInvestorValidator`](../../../investments/rental-investor-validator/interfaces/IRentalInvestorValidator.md)

package/docs/calculations/can-invest-by-user/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/can-invest-by-user
-
-# calculations/can-invest-by-user
-
-## Functions
-
-- [canInvestByUser](functions/canInvestByUser.md)

package/docs/calculations/cash-on-cash-return/functions/cashOnCashReturn.md

@@ -1,29 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/cash-on-cash-return](../index.md) / cashOnCashReturn
-
-# Function: cashOnCashReturn()
-
-> **cashOnCashReturn**(`annualCashFlow`, `costDownPrice`): `number`
-
-Defined in: [calculations/cash-on-cash-return.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/cash-on-cash-return.ts#L9)
-
-determines from the cash down you put on a property and the cash flow, it states how well you leveraged your money
-
-## Parameters
-
-### annualCashFlow
-
-`number`
-
-### costDownPrice
-
-`number`
-
-## Returns
-
-`number`
-
-returns a percentage value XX.XX%

package/docs/calculations/cash-on-cash-return/index.md

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

package/docs/calculations/get-cost-down/functions/getCostDown.md

@@ -1,27 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-cost-down](../index.md) / getCostDown
-
-# Function: getCostDown()
-
-> **getCostDown**(`purchasePrice`, `costDownPercent`): `number`
-
-Defined in: [calculations/get-cost-down.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-cost-down.ts#L8)
-
-returns the the total cash down for a single family home
-
-## Parameters
-
-### purchasePrice
-
-`number`
-
-### costDownPercent
-
-`number`
-
-## Returns
-
-`number`

package/docs/calculations/get-cost-down/index.md

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

package/docs/calculations/get-cost-down-user-investment-results/functions/getCostDownUserInvestmentResults.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-cost-down-user-investment-results](../index.md) / getCostDownUserInvestmentResults
-
-# Function: getCostDownUserInvestmentResults()
-
-> **getCostDownUserInvestmentResults**(`rental`, `holdRules`, `purchaseRules`, `date`): [`UserInvestResult`](../../../investments/user-invest-result/classes/UserInvestResult.md)[]
-
-Defined in: [calculations/get-cost-down-user-investment-results.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-cost-down-user-investment-results.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`](../../../investments/user-invest-result/classes/UserInvestResult.md)[]

package/docs/calculations/get-cost-down-user-investment-results/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/get-cost-down-user-investment-results
-
-# calculations/get-cost-down-user-investment-results
-
-## Functions
-
-- [getCostDownUserInvestmentResults](functions/getCostDownUserInvestmentResults.md)

package/docs/calculations/get-equity-capture-amount/functions/getEquityCaptureAmount.md

@@ -1,31 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-equity-capture-amount](../index.md) / getEquityCaptureAmount
-
-# Function: getEquityCaptureAmount()
-
-> **getEquityCaptureAmount**(`investmentPercent`, `purchasePrice`, `salePrice`): `number`
-
-Defined in: [calculations/get-equity-capture-amount.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-equity-capture-amount.ts#L9)
-
-## Parameters
-
-### investmentPercent
-
-`number`
-
-this is xx.xx% number
-
-### purchasePrice
-
-`number`
-
-### salePrice
-
-`number`
-
-## Returns
-
-`number`

package/docs/calculations/get-equity-capture-amount/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/get-equity-capture-amount
-
-# calculations/get-equity-capture-amount
-
-## Functions
-
-- [getEquityCaptureAmount](functions/getEquityCaptureAmount.md)

package/docs/calculations/get-equity-capture-user-investment-results/functions/getEquityCaptureUserInvestmentResults.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-equity-capture-user-investment-results](../index.md) / getEquityCaptureUserInvestmentResults
-
-# Function: getEquityCaptureUserInvestmentResults()
-
-> **getEquityCaptureUserInvestmentResults**(`rental`, `holdRules`, `purchaseRules`, `date`): [`UserInvestResult`](../../../investments/user-invest-result/classes/UserInvestResult.md)[]
-
-Defined in: [calculations/get-equity-capture-user-investment-results.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-equity-capture-user-investment-results.ts#L12)
-
-## 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`](../../../investments/user-invest-result/classes/UserInvestResult.md)[]

package/docs/calculations/get-equity-capture-user-investment-results/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/get-equity-capture-user-investment-results
-
-# calculations/get-equity-capture-user-investment-results
-
-## Functions
-
-- [getEquityCaptureUserInvestmentResults](functions/getEquityCaptureUserInvestmentResults.md)

package/docs/calculations/get-investment-percent/functions/getInvestmentPercent.md

@@ -1,27 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-investment-percent](../index.md) / getInvestmentPercent
-
-# Function: getInvestmentPercent()
-
-> **getInvestmentPercent**(`costDown`, `purchasePrice`): `number`
-
-Defined in: [calculations/get-investment-percent.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-investment-percent.ts#L6)
-
-returns a percentage number (none float like) xx.xx%
-
-## Parameters
-
-### costDown
-
-`number`
-
-### purchasePrice
-
-`number`
-
-## Returns
-
-`number`

package/docs/calculations/get-investment-percent/index.md

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

package/docs/calculations/get-min-cost-down-by-rule/functions/getMinCostDownByRule.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [calculations/get-min-cost-down-by-rule](../index.md) / getMinCostDownByRule
-
-# Function: getMinCostDownByRule()
-
-> **getMinCostDownByRule**(`rental`, `purchaseRules`): `number`
-
-Defined in: [calculations/get-min-cost-down-by-rule.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/calculations/get-min-cost-down-by-rule.ts#L5)
-
-## Parameters
-
-### rental
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-### purchaseRules
-
-[`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
-
-## Returns
-
-`number`

package/docs/calculations/get-min-cost-down-by-rule/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / calculations/get-min-cost-down-by-rule
-
-# calculations/get-min-cost-down-by-rule
-
-## Functions
-
-- [getMinCostDownByRule](functions/getMinCostDownByRule.md)