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

package/docs/index/index.md

@@ -1,487 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../modules.md) / index
-
-# index
-
-## References
-
-### AtLeastOrMore
-
-Re-exports [AtLeastOrMore](../rules/eval-types/functions/AtLeastOrMore.md)
-
----
-
-### canInvestByUser
-
-Re-exports [canInvestByUser](../calculations/can-invest-by-user/functions/canInvestByUser.md)
-
----
-
-### cashOnCashReturn
-
-Re-exports [cashOnCashReturn](../calculations/cash-on-cash-return/functions/cashOnCashReturn.md)
-
----
-
-### cloneDateUtc
-
-Re-exports [cloneDateUtc](../utils/data-clone-date/functions/cloneDateUtc.md)
-
----
-
-### defaultHasMetGoalOrMaxTime
-
-Re-exports [defaultHasMetGoalOrMaxTime](../time/default-has-met-goal-or-max-time/functions/defaultHasMetGoalOrMaxTime.md)
-
----
-
-### ensureArray
-
-Re-exports [ensureArray](../utils/ensure/functions/ensureArray.md)
-
----
-
-### EnsureArrayPredicate
-
-Re-exports [EnsureArrayPredicate](../utils/ensure/type-aliases/EnsureArrayPredicate.md)
-
----
-
-### EvalType
-
-Re-exports [EvalType](../rules/eval-type/type-aliases/EvalType.md)
-
----
-
-### GenerateProperty
-
-Re-exports [GenerateProperty](../generators/generate-property/type-aliases/GenerateProperty.md)
-
----
-
-### generateRentalPassiveApartment
-
-Re-exports [generateRentalPassiveApartment](../generators/factory-passive-apartment/functions/generateRentalPassiveApartment.md)
-
----
-
-### generateSingleFamily
-
-Re-exports [generateSingleFamily](../generators/factory-single-family/functions/generateSingleFamily.md)
-
----
-
-### genericGenerateProperty
-
-Re-exports [genericGenerateProperty](../generators/generic-generate-property/functions/genericGenerateProperty.md)
-
----
-
-### getCostDown
-
-Re-exports [getCostDown](../calculations/get-cost-down/functions/getCostDown.md)
-
----
-
-### getCostDownUserInvestmentResults
-
-Re-exports [getCostDownUserInvestmentResults](../calculations/get-cost-down-user-investment-results/functions/getCostDownUserInvestmentResults.md)
-
----
-
-### getEnumTypeByValue
-
-Re-exports [getEnumTypeByValue](../rules/get-enum-type-by-value/functions/getEnumTypeByValue.md)
-
----
-
-### getEquityCaptureAmount
-
-Re-exports [getEquityCaptureAmount](../calculations/get-equity-capture-amount/functions/getEquityCaptureAmount.md)
-
----
-
-### getEquityCaptureUserInvestmentResults
-
-Re-exports [getEquityCaptureUserInvestmentResults](../calculations/get-equity-capture-user-investment-results/functions/getEquityCaptureUserInvestmentResults.md)
-
----
-
-### getInvestmentPercent
-
-Re-exports [getInvestmentPercent](../calculations/get-investment-percent/functions/getInvestmentPercent.md)
-
----
-
-### getInvestmentReasons
-
-Re-exports [getInvestmentReasons](../investments/investment-reasons-decorator/functions/getInvestmentReasons.md)
-
----
-
-### getInvestmentReasonsForPurchaseTypes
-
-Re-exports [getInvestmentReasonsForPurchaseTypes](../investments/investment-reasons-decorator/functions/getInvestmentReasonsForPurchaseTypes.md)
-
----
-
-### getMonthlyMortgage
-
-Re-exports [getMonthlyMortgage](../calculations/get-monthly-mortgage/functions/getMonthlyMortgage.md)
-
----
-
-### getMonthlyPrincipalInterestTaxInterest
-
-Re-exports [getMonthlyPrincipalInterestTaxInterest](../calculations/get-monthly-principal-interest-tax-interest/functions/getMonthlyPrincipalInterestTaxInterest.md)
-
----
-
-### getRules
-
-Re-exports [getRules](../rules/get-rules/functions/getRules.md)
-
----
-
-### getSellPriceEstimate
-
-Re-exports [getSellPriceEstimate](../calculations/get-sell-price-estimate/functions/getSellPriceEstimate.md)
-
----
-
-### HasMetGoalOrMaxTime
-
-Re-exports [HasMetGoalOrMaxTime](../time/has-met-goal-or-max-time/type-aliases/HasMetGoalOrMaxTime.md)
-
----
-
-### HoldRuleTypes
-
-Re-exports [HoldRuleTypes](../rules/hold-rule-types/enumerations/HoldRuleTypes.md)
-
----
-
-### IEntityExistence
-
-Re-exports [IEntityExistence](../properties/i-entity-existence/interfaces/IEntityExistence.md)
-
----
-
-### IGenOptions
-
-Re-exports [IGenOptions](../time/simulate/interfaces/IGenOptions.md)
-
----
-
-### IHistoricalProperty
-
-Re-exports [IHistoricalProperty](../time/i-historical-property/interfaces/IHistoricalProperty.md)
-
----
-
-### IHistoricalReason
-
-Re-exports [IHistoricalReason](../time/i-historical-reason/interfaces/IHistoricalReason.md)
-
----
-
-### ILedgerCollection
-
-Re-exports [ILedgerCollection](../ledger/ledger-collection/interfaces/ILedgerCollection.md)
-
----
-
-### ILedgerSummary
-
-Re-exports [ILedgerSummary](../ledger/i-ledger-summary/interfaces/ILedgerSummary.md)
-
----
-
-### ILoanSetting
-
-Re-exports [ILoanSetting](../loans/i-loan-settings/interfaces/ILoanSetting.md)
-
----
-
-### ILoopOptions
-
-Re-exports [ILoopOptions](../time/i-loop-options/interfaces/ILoopOptions.md)
-
----
-
-### ILoopRecursiveOptions
-
-Re-exports [ILoopRecursiveOptions](../time/i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md)
-
----
-
-### InvestmentReasonForHoldRuleTypes
-
-Re-exports [InvestmentReasonForHoldRuleTypes](../investments/investment-reasons-decorator/functions/InvestmentReasonForHoldRuleTypes.md)
-
----
-
-### InvestmentReasonForPurchaseRuleTypes
-
-Re-exports [InvestmentReasonForPurchaseRuleTypes](../investments/investment-reasons-decorator/functions/InvestmentReasonForPurchaseRuleTypes.md)
-
----
-
-### InvestmentReasons
-
-Re-exports [InvestmentReasons](../investments/investment-reasons/enumerations/InvestmentReasons.md)
-
----
-
-### IPropertyEntity
-
-Re-exports [IPropertyEntity](../properties/i-property-entity/interfaces/IPropertyEntity.md)
-
----
-
-### IPropertyEntityOptions
-
-Re-exports [IPropertyEntityOptions](../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md)
-
----
-
-### IReasonToRule
-
-Re-exports [IReasonToRule](../investments/reason-to-rule/interfaces/IReasonToRule.md)
-
----
-
-### IReasonToRuleMeta
-
-Re-exports [IReasonToRuleMeta](../investments/reason-to-rule/interfaces/IReasonToRuleMeta.md)
-
----
-
-### IRentalGenerator
-
-Re-exports [IRentalGenerator](../generators/rental-generator/interfaces/IRentalGenerator.md)
-
----
-
-### IRentalInvestorValidator
-
-Re-exports [IRentalInvestorValidator](../investments/rental-investor-validator/interfaces/IRentalInvestorValidator.md)
-
----
-
-### IRentalPropertyEntity
-
-Re-exports [IRentalPropertyEntity](../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
----
-
-### IRule
-
-Re-exports [IRule](../rules/i-rule/interfaces/IRule.md)
-
----
-
-### IRuleEvaluation
-
-Re-exports [IRuleEvaluation](../rules/rule-evaluation/interfaces/IRuleEvaluation.md)
-
----
-
-### ISimulateOptions
-
-Re-exports [ISimulateOptions](../time/simulate/interfaces/ISimulateOptions.md)
-
----
-
-### ITimeline
-
-Re-exports [ITimeline](../time/timeline/interfaces/ITimeline.md)
-
----
-
-### IUser
-
-Re-exports [IUser](../account/user/interfaces/IUser.md)
-
----
-
-### IUserGoal
-
-Re-exports [IUserGoal](../account/i-user-goal/interfaces/IUserGoal.md)
-
----
-
-### IUserInvestorCheck
-
-Re-exports [IUserInvestorCheck](../account/i-user-investor-check/interfaces/IUserInvestorCheck.md)
-
----
-
-### IUserInvestResult
-
-Re-exports [IUserInvestResult](../investments/user-invest-result/interfaces/IUserInvestResult.md)
-
----
-
-### IValueCache
-
-Re-exports [IValueCache](../caching/value-cache/interfaces/IValueCache.md)
-
----
-
-### LedgerCollection
-
-Re-exports [LedgerCollection](../ledger/ledger-collection/classes/LedgerCollection.md)
-
----
-
-### LedgerItem
-
-Re-exports [LedgerItem](../ledger/ledger-item/classes/LedgerItem.md)
-
----
-
-### LedgerItemPredicate
-
-Re-exports [LedgerItemPredicate](../ledger/ledger-collection/type-aliases/LedgerItemPredicate.md)
-
----
-
-### LedgerItemType
-
-Re-exports [LedgerItemType](../ledger/ledger-item-type/enumerations/LedgerItemType.md)
-
----
-
-### LoanSettings
-
-Re-exports [LoanSettings](../loans/loan-settings/enumerations/LoanSettings.md)
-
----
-
-### movement
-
-Re-exports [movement](../time/movement/functions/movement.md)
-
----
-
-### NoMoreThan
-
-Re-exports [NoMoreThan](../rules/eval-types/functions/NoMoreThan.md)
-
----
-
-### PropertyDecoratorType
-
-Re-exports [PropertyDecoratorType](../investments/investment-reasons-decorator/type-aliases/PropertyDecoratorType.md)
-
----
-
-### PropertyType
-
-Re-exports [PropertyType](../properties/property-type/enumerations/PropertyType.md)
-
----
-
-### PurchaseRuleTypes
-
-Re-exports [PurchaseRuleTypes](../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)
-
----
-
-### randomNumberBetween
-
-Re-exports [randomNumberBetween](../utils/data-number/functions/randomNumberBetween.md)
-
----
-
-### randomPropertyEntity
-
-Re-exports [randomPropertyEntity](../utils/data-property-entity/functions/randomPropertyEntity.md)
-
----
-
-### RandomPropertyEntity
-
-Re-exports [RandomPropertyEntity](../utils/data-property-entity/type-aliases/RandomPropertyEntity.md)
-
----
-
-### ReasonToRule
-
-Re-exports [ReasonToRule](../investments/reason-to-rule/classes/ReasonToRule.md)
-
----
-
-### RentalGenerator
-
-Re-exports [RentalGenerator](../generators/rental-generator/classes/RentalGenerator.md)
-
----
-
-### RentalInvestorValidator
-
-Re-exports [RentalInvestorValidator](../investments/rental-investor-validator/classes/RentalInvestorValidator.md)
-
----
-
-### RentalPassiveApartment
-
-Re-exports [RentalPassiveApartment](../properties/rental-passive-apartment/classes/RentalPassiveApartment.md)
-
----
-
-### RentalSingleFamily
-
-Re-exports [RentalSingleFamily](../properties/rental-single-family/classes/RentalSingleFamily.md)
-
----
-
-### returnOnCapitalGain
-
-Re-exports [returnOnCapitalGain](../calculations/return-on-capital-gain/functions/returnOnCapitalGain.md)
-
----
-
-### RuleEvaluation
-
-Re-exports [RuleEvaluation](../rules/rule-evaluation/classes/RuleEvaluation.md)
-
----
-
-### simulate
-
-Re-exports [simulate](../time/simulate/functions/simulate.md)
-
----
-
-### Timeline
-
-Re-exports [Timeline](../time/timeline/classes/Timeline.md)
-
----
-
-### updateHistoricalRentals
-
-Re-exports [updateHistoricalRentals](../time/update-historical-rentals/functions/updateHistoricalRentals.md)
-
----
-
-### User
-
-Re-exports [User](../account/user/classes/User.md)
-
----
-
-### UserInvestResult
-
-Re-exports [UserInvestResult](../investments/user-invest-result/classes/UserInvestResult.md)
-
----
-
-### ValueCache
-
-Re-exports [ValueCache](../caching/value-cache/classes/ValueCache.md)