@cubedelement.com/realty-investor-timeline 5.5.0 → 5.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/dist/src/account/i-user-goal.d.ts +5 -0
- package/dist/src/account/user.d.ts +20 -1
- package/dist/src/account/user.js +21 -0
- package/dist/src/caching/value-cache.js +3 -1
- package/dist/src/ledger/ledger-collection.d.ts +4 -0
- package/dist/src/ledger/ledger-collection.js +44 -1
- package/dist/src/ledger/ledger-item.d.ts +5 -0
- package/dist/src/ledger/ledger-item.js +19 -0
- package/dist/src/time/default-has-met-goal-or-max-time.js +1 -1
- package/dist/src/time/looper.js +1 -1
- package/dist/src/utils/data-clone-date.js +1 -1
- package/dist/src/utils/get-date-quarter.d.ts +1 -0
- package/dist/src/utils/get-date-quarter.js +5 -0
- package/package.json +1 -1
- package/.github/dependabot.yml +0 -10
- package/docs/_media/badge.svg +0 -1
- package/docs/account/i-user-goal/index.md +0 -11
- package/docs/account/i-user-goal/interfaces/IUserGoal.md +0 -47
- package/docs/account/i-user-investor-check/index.md +0 -11
- package/docs/account/i-user-investor-check/interfaces/IUserInvestorCheck.md +0 -206
- package/docs/account/index.md +0 -31
- package/docs/account/user/classes/User.md +0 -312
- package/docs/account/user/index.md +0 -15
- package/docs/account/user/interfaces/IUser.md +0 -282
- package/docs/caching/index.md +0 -19
- package/docs/caching/value-cache/classes/ValueCache.md +0 -194
- package/docs/caching/value-cache/index.md +0 -15
- package/docs/caching/value-cache/interfaces/IValueCache.md +0 -104
- package/docs/calculations/can-invest-by-user/functions/canInvestByUser.md +0 -35
- package/docs/calculations/can-invest-by-user/index.md +0 -11
- package/docs/calculations/cash-on-cash-return/functions/cashOnCashReturn.md +0 -29
- package/docs/calculations/cash-on-cash-return/index.md +0 -11
- package/docs/calculations/get-cost-down/functions/getCostDown.md +0 -27
- package/docs/calculations/get-cost-down/index.md +0 -11
- package/docs/calculations/get-cost-down-user-investment-results/functions/getCostDownUserInvestmentResults.md +0 -33
- package/docs/calculations/get-cost-down-user-investment-results/index.md +0 -11
- package/docs/calculations/get-equity-capture-amount/functions/getEquityCaptureAmount.md +0 -31
- package/docs/calculations/get-equity-capture-amount/index.md +0 -11
- package/docs/calculations/get-equity-capture-user-investment-results/functions/getEquityCaptureUserInvestmentResults.md +0 -33
- package/docs/calculations/get-equity-capture-user-investment-results/index.md +0 -11
- package/docs/calculations/get-investment-percent/functions/getInvestmentPercent.md +0 -27
- package/docs/calculations/get-investment-percent/index.md +0 -11
- package/docs/calculations/get-min-cost-down-by-rule/functions/getMinCostDownByRule.md +0 -25
- package/docs/calculations/get-min-cost-down-by-rule/index.md +0 -11
- package/docs/calculations/get-monthly-mortgage/functions/getMonthlyMortgage.md +0 -43
- package/docs/calculations/get-monthly-mortgage/index.md +0 -11
- package/docs/calculations/get-monthly-principal-interest-tax-interest/functions/getMonthlyPrincipalInterestTaxInterest.md +0 -43
- package/docs/calculations/get-monthly-principal-interest-tax-interest/index.md +0 -11
- package/docs/calculations/get-sell-price-estimate/functions/getSellPriceEstimate.md +0 -33
- package/docs/calculations/get-sell-price-estimate/index.md +0 -11
- package/docs/calculations/index.md +0 -73
- package/docs/calculations/return-on-capital-gain/functions/returnOnCapitalGain.md +0 -31
- package/docs/calculations/return-on-capital-gain/index.md +0 -11
- package/docs/formatters/currency/functions/default.md +0 -21
- package/docs/formatters/currency/index.md +0 -11
- package/docs/formatters/index.md +0 -7
- package/docs/generators/factory-passive-apartment/functions/generateRentalPassiveApartment.md +0 -35
- package/docs/generators/factory-passive-apartment/index.md +0 -11
- package/docs/generators/factory-single-family/functions/generateSingleFamily.md +0 -35
- package/docs/generators/factory-single-family/index.md +0 -11
- package/docs/generators/generate-property/index.md +0 -11
- package/docs/generators/generate-property/type-aliases/GenerateProperty.md +0 -37
- package/docs/generators/generic-generate-property/functions/genericGenerateProperty.md +0 -35
- package/docs/generators/generic-generate-property/index.md +0 -11
- package/docs/generators/i-property-entity-options/index.md +0 -11
- package/docs/generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md +0 -113
- package/docs/generators/index.md +0 -49
- package/docs/generators/rental-generator/classes/RentalGenerator.md +0 -248
- package/docs/generators/rental-generator/index.md +0 -15
- package/docs/generators/rental-generator/interfaces/IRentalGenerator.md +0 -65
- package/docs/index/index.md +0 -487
- package/docs/index.md +0 -258
- package/docs/investments/index.md +0 -85
- package/docs/investments/investment-reasons/enumerations/InvestmentReasons.md +0 -119
- package/docs/investments/investment-reasons/index.md +0 -11
- package/docs/investments/investment-reasons-decorator/functions/InvestmentReasonForHoldRuleTypes.md +0 -25
- package/docs/investments/investment-reasons-decorator/functions/InvestmentReasonForPurchaseRuleTypes.md +0 -25
- package/docs/investments/investment-reasons-decorator/functions/getInvestmentReasons.md +0 -33
- package/docs/investments/investment-reasons-decorator/functions/getInvestmentReasonsForPurchaseTypes.md +0 -25
- package/docs/investments/investment-reasons-decorator/index.md +0 -18
- package/docs/investments/investment-reasons-decorator/type-aliases/PropertyDecoratorType.md +0 -29
- package/docs/investments/reason-to-rule/classes/ReasonToRule.md +0 -263
- package/docs/investments/reason-to-rule/index.md +0 -16
- package/docs/investments/reason-to-rule/interfaces/IReasonToRule.md +0 -189
- package/docs/investments/reason-to-rule/interfaces/IReasonToRuleMeta.md +0 -33
- package/docs/investments/rental-investor-validator/classes/RentalInvestorValidator.md +0 -53
- package/docs/investments/rental-investor-validator/index.md +0 -15
- package/docs/investments/rental-investor-validator/interfaces/IRentalInvestorValidator.md +0 -25
- package/docs/investments/user-invest-result/classes/UserInvestResult.md +0 -65
- package/docs/investments/user-invest-result/index.md +0 -15
- package/docs/investments/user-invest-result/interfaces/IUserInvestResult.md +0 -25
- package/docs/investments/user-result-estimates/index.md +0 -11
- package/docs/investments/user-result-estimates/type-aliases/UserResultEstimates.md +0 -33
- package/docs/ledger/i-ledger-summary/index.md +0 -11
- package/docs/ledger/i-ledger-summary/interfaces/ILedgerSummary.md +0 -57
- package/docs/ledger/index.md +0 -43
- package/docs/ledger/ledger-collection/classes/LedgerCollection.md +0 -425
- package/docs/ledger/ledger-collection/index.md +0 -19
- package/docs/ledger/ledger-collection/interfaces/ILedgerCollection.md +0 -313
- package/docs/ledger/ledger-collection/type-aliases/LedgerItemPredicate.md +0 -25
- package/docs/ledger/ledger-item/classes/LedgerItem.md +0 -211
- package/docs/ledger/ledger-item/index.md +0 -11
- package/docs/ledger/ledger-item-type/enumerations/LedgerItemType.md +0 -57
- package/docs/ledger/ledger-item-type/index.md +0 -11
- package/docs/loans/i-loan-settings/index.md +0 -11
- package/docs/loans/i-loan-settings/interfaces/ILoanSetting.md +0 -33
- package/docs/loans/index.md +0 -19
- package/docs/loans/loan-settings/enumerations/LoanSettings.md +0 -41
- package/docs/loans/loan-settings/index.md +0 -11
- package/docs/modules.md +0 -88
- package/docs/properties/i-entity-existence/index.md +0 -11
- package/docs/properties/i-entity-existence/interfaces/IEntityExistence.md +0 -33
- package/docs/properties/i-property-entity/index.md +0 -11
- package/docs/properties/i-property-entity/interfaces/IPropertyEntity.md +0 -159
- package/docs/properties/i-rental-property-entity/index.md +0 -11
- package/docs/properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md +0 -416
- package/docs/properties/index.md +0 -43
- package/docs/properties/property-sort/functions/default.md +0 -35
- package/docs/properties/property-sort/index.md +0 -11
- package/docs/properties/property-type/enumerations/PropertyType.md +0 -33
- package/docs/properties/property-type/index.md +0 -11
- package/docs/properties/rental-passive-apartment/classes/RentalPassiveApartment.md +0 -558
- package/docs/properties/rental-passive-apartment/index.md +0 -11
- package/docs/properties/rental-single-family/classes/RentalSingleFamily.md +0 -639
- package/docs/properties/rental-single-family/index.md +0 -11
- package/docs/rules/eval-type/index.md +0 -11
- package/docs/rules/eval-type/type-aliases/EvalType.md +0 -25
- package/docs/rules/eval-types/functions/AtLeastOrMore.md +0 -25
- package/docs/rules/eval-types/functions/NoMoreThan.md +0 -25
- package/docs/rules/eval-types/index.md +0 -12
- package/docs/rules/get-enum-type-by-value/functions/getEnumTypeByValue.md +0 -23
- package/docs/rules/get-enum-type-by-value/index.md +0 -11
- package/docs/rules/get-rules/functions/getRules.md +0 -27
- package/docs/rules/get-rules/index.md +0 -11
- package/docs/rules/hold-rule-types/enumerations/HoldRuleTypes.md +0 -49
- package/docs/rules/hold-rule-types/index.md +0 -11
- package/docs/rules/i-rule/index.md +0 -11
- package/docs/rules/i-rule/interfaces/IRule.md +0 -41
- package/docs/rules/index.md +0 -67
- package/docs/rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md +0 -78
- package/docs/rules/purchase-rule-types/index.md +0 -11
- package/docs/rules/rule-evaluation/classes/RuleEvaluation.md +0 -103
- package/docs/rules/rule-evaluation/index.md +0 -15
- package/docs/rules/rule-evaluation/interfaces/IRuleEvaluation.md +0 -73
- package/docs/time/default-has-met-goal-or-max-time/functions/defaultHasMetGoalOrMaxTime.md +0 -39
- package/docs/time/default-has-met-goal-or-max-time/index.md +0 -11
- package/docs/time/has-met-goal-or-max-time/index.md +0 -11
- package/docs/time/has-met-goal-or-max-time/type-aliases/HasMetGoalOrMaxTime.md +0 -39
- package/docs/time/i-historical-property/index.md +0 -11
- package/docs/time/i-historical-property/interfaces/IHistoricalProperty.md +0 -25
- package/docs/time/i-historical-reason/index.md +0 -11
- package/docs/time/i-historical-reason/interfaces/IHistoricalReason.md +0 -25
- package/docs/time/i-loop-options/index.md +0 -11
- package/docs/time/i-loop-options/interfaces/ILoopOptions.md +0 -71
- package/docs/time/i-loop-recursive-options/index.md +0 -11
- package/docs/time/i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md +0 -33
- package/docs/time/index.md +0 -85
- package/docs/time/looper/functions/looper.md +0 -25
- package/docs/time/looper/index.md +0 -15
- package/docs/time/looper/type-aliases/LooperType.md +0 -25
- package/docs/time/movement/functions/movement.md +0 -27
- package/docs/time/movement/index.md +0 -11
- package/docs/time/simulate/functions/simulate.md +0 -23
- package/docs/time/simulate/index.md +0 -16
- package/docs/time/simulate/interfaces/IGenOptions.md +0 -163
- package/docs/time/simulate/interfaces/ISimulateOptions.md +0 -115
- package/docs/time/timeline/classes/Timeline.md +0 -175
- package/docs/time/timeline/index.md +0 -15
- package/docs/time/timeline/interfaces/ITimeline.md +0 -83
- package/docs/time/update-historical-rentals/functions/updateHistoricalRentals.md +0 -41
- package/docs/time/update-historical-rentals/index.md +0 -11
- package/docs/utils/data-are-same-date/functions/default.md +0 -25
- package/docs/utils/data-are-same-date/index.md +0 -11
- package/docs/utils/data-clone-date/functions/cloneDateUtc.md +0 -27
- package/docs/utils/data-clone-date/index.md +0 -11
- package/docs/utils/data-compare-date/functions/default.md +0 -28
- package/docs/utils/data-compare-date/index.md +0 -11
- package/docs/utils/data-number/functions/randomNumberBetween.md +0 -25
- package/docs/utils/data-number/index.md +0 -11
- package/docs/utils/data-property-entity/functions/randomPropertyEntity.md +0 -23
- package/docs/utils/data-property-entity/index.md +0 -15
- package/docs/utils/data-property-entity/type-aliases/RandomPropertyEntity.md +0 -21
- package/docs/utils/ensure/functions/ensureArray.md +0 -39
- package/docs/utils/ensure/index.md +0 -15
- package/docs/utils/ensure/type-aliases/EnsureArrayPredicate.md +0 -29
- package/docs/utils/index.md +0 -43
|
@@ -1,115 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/simulate](../index.md) / ISimulateOptions
|
|
6
|
-
|
|
7
|
-
# Interface: ISimulateOptions
|
|
8
|
-
|
|
9
|
-
Defined in: [time/simulate.ts:27](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L27)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### amountInSavings
|
|
14
|
-
|
|
15
|
-
> **amountInSavings**: `number`
|
|
16
|
-
|
|
17
|
-
Defined in: [time/simulate.ts:31](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L31)
|
|
18
|
-
|
|
19
|
-
this is what you have saved up currently to invest in
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
### generatorOptionsPassiveApartment?
|
|
24
|
-
|
|
25
|
-
> `optional` **generatorOptionsPassiveApartment**: [`IGenOptions`](IGenOptions.md)
|
|
26
|
-
|
|
27
|
-
Defined in: [time/simulate.ts:75](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L75)
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
### generatorOptionsSingleFamily?
|
|
32
|
-
|
|
33
|
-
> `optional` **generatorOptionsSingleFamily**: [`IGenOptions`](IGenOptions.md)
|
|
34
|
-
|
|
35
|
-
Defined in: [time/simulate.ts:73](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L73)
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
### hasMetGoalOrMaxTime?
|
|
40
|
-
|
|
41
|
-
> `optional` **hasMetGoalOrMaxTime**: [`HasMetGoalOrMaxTime`](../../has-met-goal-or-max-time/type-aliases/HasMetGoalOrMaxTime.md)
|
|
42
|
-
|
|
43
|
-
Defined in: [time/simulate.ts:71](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L71)
|
|
44
|
-
|
|
45
|
-
This is how the system knows when to quit. If no value is supplied, it will use `defaultHasMetGoalOrMaxTime`.
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
### holdRules
|
|
50
|
-
|
|
51
|
-
> **holdRules**: [`IRule`](../../../rules/i-rule/interfaces/IRule.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]
|
|
52
|
-
|
|
53
|
-
Defined in: [time/simulate.ts:51](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L51)
|
|
54
|
-
|
|
55
|
-
a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
### loanSettings
|
|
60
|
-
|
|
61
|
-
> **loanSettings**: [`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]
|
|
62
|
-
|
|
63
|
-
Defined in: [time/simulate.ts:46](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L46)
|
|
64
|
-
|
|
65
|
-
loan basics about you. For example, if you have a great credit, you'll probably have a low interest rate. so that's 3%. With rentals, you are 1% higher, so make it 4%.
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
### maxYears?
|
|
70
|
-
|
|
71
|
-
> `optional` **maxYears**: `number`
|
|
72
|
-
|
|
73
|
-
Defined in: [time/simulate.ts:66](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L66)
|
|
74
|
-
|
|
75
|
-
how long should this run in years? A common number is 25 to 30 years before giving up.
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
### monthlyIncomeAmountGoal
|
|
80
|
-
|
|
81
|
-
> **monthlyIncomeAmountGoal**: `number`
|
|
82
|
-
|
|
83
|
-
Defined in: [time/simulate.ts:36](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L36)
|
|
84
|
-
|
|
85
|
-
What you want to get to for cash flow. This has been monthly expenses for many.
|
|
86
|
-
|
|
87
|
-
---
|
|
88
|
-
|
|
89
|
-
### monthlySavedAmount
|
|
90
|
-
|
|
91
|
-
> **monthlySavedAmount**: `number`
|
|
92
|
-
|
|
93
|
-
Defined in: [time/simulate.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L41)
|
|
94
|
-
|
|
95
|
-
After your paycheck you would take your excess and save it. Here is that amount.
|
|
96
|
-
|
|
97
|
-
---
|
|
98
|
-
|
|
99
|
-
### purchaseRules
|
|
100
|
-
|
|
101
|
-
> **purchaseRules**: [`IRule`](../../../rules/i-rule/interfaces/IRule.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
|
|
102
|
-
|
|
103
|
-
Defined in: [time/simulate.ts:56](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L56)
|
|
104
|
-
|
|
105
|
-
This is how to prioritize the properties that come up. Use one, or use all rules! The order you put them in here, is the order it evaluates them as. [PurchaseRuleTypes](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md) for possible rules
|
|
106
|
-
|
|
107
|
-
---
|
|
108
|
-
|
|
109
|
-
### startDate?
|
|
110
|
-
|
|
111
|
-
> `optional` **startDate**: `Date`
|
|
112
|
-
|
|
113
|
-
Defined in: [time/simulate.ts:61](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L61)
|
|
114
|
-
|
|
115
|
-
when does this start?
|
|
@@ -1,175 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/timeline](../index.md) / Timeline
|
|
6
|
-
|
|
7
|
-
# Class: Timeline
|
|
8
|
-
|
|
9
|
-
Defined in: [time/timeline.ts:19](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L19)
|
|
10
|
-
|
|
11
|
-
## Implements
|
|
12
|
-
|
|
13
|
-
- [`ITimeline`](../interfaces/ITimeline.md)
|
|
14
|
-
|
|
15
|
-
## Constructors
|
|
16
|
-
|
|
17
|
-
### new Timeline()
|
|
18
|
-
|
|
19
|
-
> **new Timeline**(`startDate`, `endDate`, `rentals`, `user`): [`Timeline`](Timeline.md)
|
|
20
|
-
|
|
21
|
-
Defined in: [time/timeline.ts:20](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L20)
|
|
22
|
-
|
|
23
|
-
#### Parameters
|
|
24
|
-
|
|
25
|
-
##### startDate
|
|
26
|
-
|
|
27
|
-
`Date`
|
|
28
|
-
|
|
29
|
-
##### endDate
|
|
30
|
-
|
|
31
|
-
`Date`
|
|
32
|
-
|
|
33
|
-
##### rentals
|
|
34
|
-
|
|
35
|
-
[`IHistoricalProperty`](../../i-historical-property/interfaces/IHistoricalProperty.md)[]
|
|
36
|
-
|
|
37
|
-
##### user
|
|
38
|
-
|
|
39
|
-
[`IUser`](../../../account/user/interfaces/IUser.md)
|
|
40
|
-
|
|
41
|
-
#### Returns
|
|
42
|
-
|
|
43
|
-
[`Timeline`](Timeline.md)
|
|
44
|
-
|
|
45
|
-
## Properties
|
|
46
|
-
|
|
47
|
-
### endDate
|
|
48
|
-
|
|
49
|
-
> **endDate**: `Date`
|
|
50
|
-
|
|
51
|
-
Defined in: [time/timeline.ts:27](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L27)
|
|
52
|
-
|
|
53
|
-
#### Implementation of
|
|
54
|
-
|
|
55
|
-
[`ITimeline`](../interfaces/ITimeline.md).[`endDate`](../interfaces/ITimeline.md#enddate)
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
### rentals
|
|
60
|
-
|
|
61
|
-
> **rentals**: [`IHistoricalProperty`](../../i-historical-property/interfaces/IHistoricalProperty.md)[]
|
|
62
|
-
|
|
63
|
-
Defined in: [time/timeline.ts:28](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L28)
|
|
64
|
-
|
|
65
|
-
#### Implementation of
|
|
66
|
-
|
|
67
|
-
[`ITimeline`](../interfaces/ITimeline.md).[`rentals`](../interfaces/ITimeline.md#rentals)
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
### startDate
|
|
72
|
-
|
|
73
|
-
> **startDate**: `Date`
|
|
74
|
-
|
|
75
|
-
Defined in: [time/timeline.ts:29](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L29)
|
|
76
|
-
|
|
77
|
-
#### Implementation of
|
|
78
|
-
|
|
79
|
-
[`ITimeline`](../interfaces/ITimeline.md).[`startDate`](../interfaces/ITimeline.md#startdate)
|
|
80
|
-
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
### user
|
|
84
|
-
|
|
85
|
-
> **user**: [`IUser`](../../../account/user/interfaces/IUser.md)
|
|
86
|
-
|
|
87
|
-
Defined in: [time/timeline.ts:30](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L30)
|
|
88
|
-
|
|
89
|
-
#### Implementation of
|
|
90
|
-
|
|
91
|
-
[`ITimeline`](../interfaces/ITimeline.md).[`user`](../interfaces/ITimeline.md#user)
|
|
92
|
-
|
|
93
|
-
## Methods
|
|
94
|
-
|
|
95
|
-
### clone()
|
|
96
|
-
|
|
97
|
-
> **clone**(): [`ITimeline`](../interfaces/ITimeline.md)
|
|
98
|
-
|
|
99
|
-
Defined in: [time/timeline.ts:61](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L61)
|
|
100
|
-
|
|
101
|
-
#### Returns
|
|
102
|
-
|
|
103
|
-
[`ITimeline`](../interfaces/ITimeline.md)
|
|
104
|
-
|
|
105
|
-
#### Implementation of
|
|
106
|
-
|
|
107
|
-
[`ITimeline`](../interfaces/ITimeline.md).[`clone`](../interfaces/ITimeline.md#clone)
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
|
-
### getAllSummariesAnnual()
|
|
112
|
-
|
|
113
|
-
> **getAllSummariesAnnual**(): [`ILedgerSummary`](../../../ledger/i-ledger-summary/interfaces/ILedgerSummary.md)[]
|
|
114
|
-
|
|
115
|
-
Defined in: [time/timeline.ts:47](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L47)
|
|
116
|
-
|
|
117
|
-
#### Returns
|
|
118
|
-
|
|
119
|
-
[`ILedgerSummary`](../../../ledger/i-ledger-summary/interfaces/ILedgerSummary.md)[]
|
|
120
|
-
|
|
121
|
-
---
|
|
122
|
-
|
|
123
|
-
### getBalance()
|
|
124
|
-
|
|
125
|
-
> **getBalance**(`date`?): `number`
|
|
126
|
-
|
|
127
|
-
Defined in: [time/timeline.ts:39](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L39)
|
|
128
|
-
|
|
129
|
-
#### Parameters
|
|
130
|
-
|
|
131
|
-
##### date?
|
|
132
|
-
|
|
133
|
-
`Date`
|
|
134
|
-
|
|
135
|
-
#### Returns
|
|
136
|
-
|
|
137
|
-
`number`
|
|
138
|
-
|
|
139
|
-
#### Implementation of
|
|
140
|
-
|
|
141
|
-
[`ITimeline`](../interfaces/ITimeline.md).[`getBalance`](../interfaces/ITimeline.md#getbalance)
|
|
142
|
-
|
|
143
|
-
---
|
|
144
|
-
|
|
145
|
-
### getEstimatedMonthlyCashFlow()
|
|
146
|
-
|
|
147
|
-
> **getEstimatedMonthlyCashFlow**(): `number`
|
|
148
|
-
|
|
149
|
-
Defined in: [time/timeline.ts:32](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L32)
|
|
150
|
-
|
|
151
|
-
#### Returns
|
|
152
|
-
|
|
153
|
-
`number`
|
|
154
|
-
|
|
155
|
-
#### Implementation of
|
|
156
|
-
|
|
157
|
-
[`ITimeline`](../interfaces/ITimeline.md).[`getEstimatedMonthlyCashFlow`](../interfaces/ITimeline.md#getestimatedmonthlycashflow)
|
|
158
|
-
|
|
159
|
-
---
|
|
160
|
-
|
|
161
|
-
### getSummariesAnnualByYear()
|
|
162
|
-
|
|
163
|
-
> **getSummariesAnnualByYear**(`year`?): [`ILedgerSummary`](../../../ledger/i-ledger-summary/interfaces/ILedgerSummary.md)[]
|
|
164
|
-
|
|
165
|
-
Defined in: [time/timeline.ts:43](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L43)
|
|
166
|
-
|
|
167
|
-
#### Parameters
|
|
168
|
-
|
|
169
|
-
##### year?
|
|
170
|
-
|
|
171
|
-
`number`
|
|
172
|
-
|
|
173
|
-
#### Returns
|
|
174
|
-
|
|
175
|
-
[`ILedgerSummary`](../../../ledger/i-ledger-summary/interfaces/ILedgerSummary.md)[]
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/timeline
|
|
6
|
-
|
|
7
|
-
# time/timeline
|
|
8
|
-
|
|
9
|
-
## Classes
|
|
10
|
-
|
|
11
|
-
- [Timeline](classes/Timeline.md)
|
|
12
|
-
|
|
13
|
-
## Interfaces
|
|
14
|
-
|
|
15
|
-
- [ITimeline](interfaces/ITimeline.md)
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/timeline](../index.md) / ITimeline
|
|
6
|
-
|
|
7
|
-
# Interface: ITimeline
|
|
8
|
-
|
|
9
|
-
Defined in: [time/timeline.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L6)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### endDate
|
|
14
|
-
|
|
15
|
-
> **endDate**: `Date`
|
|
16
|
-
|
|
17
|
-
Defined in: [time/timeline.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L8)
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
### rentals
|
|
22
|
-
|
|
23
|
-
> **rentals**: [`IHistoricalProperty`](../../i-historical-property/interfaces/IHistoricalProperty.md)[]
|
|
24
|
-
|
|
25
|
-
Defined in: [time/timeline.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L9)
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
### startDate
|
|
30
|
-
|
|
31
|
-
> **startDate**: `Date`
|
|
32
|
-
|
|
33
|
-
Defined in: [time/timeline.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L7)
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
### user
|
|
38
|
-
|
|
39
|
-
> **user**: [`IUser`](../../../account/user/interfaces/IUser.md)
|
|
40
|
-
|
|
41
|
-
Defined in: [time/timeline.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L10)
|
|
42
|
-
|
|
43
|
-
## Methods
|
|
44
|
-
|
|
45
|
-
### clone()
|
|
46
|
-
|
|
47
|
-
> **clone**(): [`ITimeline`](ITimeline.md)
|
|
48
|
-
|
|
49
|
-
Defined in: [time/timeline.ts:16](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L16)
|
|
50
|
-
|
|
51
|
-
#### Returns
|
|
52
|
-
|
|
53
|
-
[`ITimeline`](ITimeline.md)
|
|
54
|
-
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
### getBalance()
|
|
58
|
-
|
|
59
|
-
> **getBalance**(`date`?): `number`
|
|
60
|
-
|
|
61
|
-
Defined in: [time/timeline.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L14)
|
|
62
|
-
|
|
63
|
-
#### Parameters
|
|
64
|
-
|
|
65
|
-
##### date?
|
|
66
|
-
|
|
67
|
-
`Date`
|
|
68
|
-
|
|
69
|
-
#### Returns
|
|
70
|
-
|
|
71
|
-
`number`
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
### getEstimatedMonthlyCashFlow()
|
|
76
|
-
|
|
77
|
-
> **getEstimatedMonthlyCashFlow**(): `number`
|
|
78
|
-
|
|
79
|
-
Defined in: [time/timeline.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/timeline.ts#L12)
|
|
80
|
-
|
|
81
|
-
#### Returns
|
|
82
|
-
|
|
83
|
-
`number`
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/update-historical-rentals](../index.md) / updateHistoricalRentals
|
|
6
|
-
|
|
7
|
-
# Function: updateHistoricalRentals()
|
|
8
|
-
|
|
9
|
-
> **updateHistoricalRentals**\<`TRental`\>(`type`, `propertyGenerator`, `timelineProperties`, `today`, `loanSettings`): [`IHistoricalProperty`](../../i-historical-property/interfaces/IHistoricalProperty.md)[]
|
|
10
|
-
|
|
11
|
-
Defined in: [time/update-historical-rentals.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/update-historical-rentals.ts#L7)
|
|
12
|
-
|
|
13
|
-
## Type Parameters
|
|
14
|
-
|
|
15
|
-
• **TRental** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
|
|
16
|
-
|
|
17
|
-
## Parameters
|
|
18
|
-
|
|
19
|
-
### type
|
|
20
|
-
|
|
21
|
-
() => `TRental`
|
|
22
|
-
|
|
23
|
-
### propertyGenerator
|
|
24
|
-
|
|
25
|
-
[`IRentalGenerator`](../../../generators/rental-generator/interfaces/IRentalGenerator.md)\<`TRental`\>
|
|
26
|
-
|
|
27
|
-
### timelineProperties
|
|
28
|
-
|
|
29
|
-
[`IHistoricalProperty`](../../i-historical-property/interfaces/IHistoricalProperty.md)[]
|
|
30
|
-
|
|
31
|
-
### today
|
|
32
|
-
|
|
33
|
-
`Date`
|
|
34
|
-
|
|
35
|
-
### loanSettings
|
|
36
|
-
|
|
37
|
-
[`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]
|
|
38
|
-
|
|
39
|
-
## Returns
|
|
40
|
-
|
|
41
|
-
[`IHistoricalProperty`](../../i-historical-property/interfaces/IHistoricalProperty.md)[]
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/update-historical-rentals
|
|
6
|
-
|
|
7
|
-
# time/update-historical-rentals
|
|
8
|
-
|
|
9
|
-
## Functions
|
|
10
|
-
|
|
11
|
-
- [updateHistoricalRentals](functions/updateHistoricalRentals.md)
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/data-are-same-date](../index.md) / default
|
|
6
|
-
|
|
7
|
-
# Function: default()
|
|
8
|
-
|
|
9
|
-
> **default**(`dateA`, `dateB`): `boolean`
|
|
10
|
-
|
|
11
|
-
Defined in: [utils/data-are-same-date.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/data-are-same-date.ts#L1)
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
### dateA
|
|
16
|
-
|
|
17
|
-
`Date`
|
|
18
|
-
|
|
19
|
-
### dateB
|
|
20
|
-
|
|
21
|
-
`Date`
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
`boolean`
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/data-clone-date](../index.md) / cloneDateUtc
|
|
6
|
-
|
|
7
|
-
# Function: cloneDateUtc()
|
|
8
|
-
|
|
9
|
-
> **cloneDateUtc**(`date`, `datePredicate`?): `Date`
|
|
10
|
-
|
|
11
|
-
Defined in: [utils/data-clone-date.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/data-clone-date.ts#L6)
|
|
12
|
-
|
|
13
|
-
takes an existing date, and it creates a new UTC Date with YYYY/MM/01 focus. The time is removed
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### date
|
|
18
|
-
|
|
19
|
-
`Date`
|
|
20
|
-
|
|
21
|
-
### datePredicate?
|
|
22
|
-
|
|
23
|
-
(`date`) => `void`
|
|
24
|
-
|
|
25
|
-
## Returns
|
|
26
|
-
|
|
27
|
-
`Date`
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/data-compare-date](../index.md) / default
|
|
6
|
-
|
|
7
|
-
# Function: default()
|
|
8
|
-
|
|
9
|
-
> **default**(`dateA`, `dateB`): `number`
|
|
10
|
-
|
|
11
|
-
Defined in: [utils/data-compare-date.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/data-compare-date.ts#L7)
|
|
12
|
-
|
|
13
|
-
used to determine which is before, a or b. If a, then you'll get -1, if b then 1. Finally, if everything is the
|
|
14
|
-
same, then 0.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
### dateA
|
|
19
|
-
|
|
20
|
-
`Date`
|
|
21
|
-
|
|
22
|
-
### dateB
|
|
23
|
-
|
|
24
|
-
`Date`
|
|
25
|
-
|
|
26
|
-
## Returns
|
|
27
|
-
|
|
28
|
-
`number`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/data-number](../index.md) / randomNumberBetween
|
|
6
|
-
|
|
7
|
-
# Function: randomNumberBetween()
|
|
8
|
-
|
|
9
|
-
> **randomNumberBetween**(`start`, `end`): `number`
|
|
10
|
-
|
|
11
|
-
Defined in: [utils/data-number.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/data-number.ts#L1)
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
### start
|
|
16
|
-
|
|
17
|
-
`number`
|
|
18
|
-
|
|
19
|
-
### end
|
|
20
|
-
|
|
21
|
-
`number`
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
`number`
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / utils/data-number
|
|
6
|
-
|
|
7
|
-
# utils/data-number
|
|
8
|
-
|
|
9
|
-
## Functions
|
|
10
|
-
|
|
11
|
-
- [randomNumberBetween](functions/randomNumberBetween.md)
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/data-property-entity](../index.md) / randomPropertyEntity
|
|
6
|
-
|
|
7
|
-
# Function: randomPropertyEntity()
|
|
8
|
-
|
|
9
|
-
> **randomPropertyEntity**(`options`): `Partial`\<[`IPropertyEntity`](../../../properties/i-property-entity/interfaces/IPropertyEntity.md)\>
|
|
10
|
-
|
|
11
|
-
Defined in: [utils/data-property-entity.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/data-property-entity.ts#L13)
|
|
12
|
-
|
|
13
|
-
used to generate the basic entity options, which will create id, minSellYears, sellPriceAppreciationPercent, address, and carry over purchasePrice
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### options
|
|
18
|
-
|
|
19
|
-
[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md)
|
|
20
|
-
|
|
21
|
-
## Returns
|
|
22
|
-
|
|
23
|
-
`Partial`\<[`IPropertyEntity`](../../../properties/i-property-entity/interfaces/IPropertyEntity.md)\>
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / utils/data-property-entity
|
|
6
|
-
|
|
7
|
-
# utils/data-property-entity
|
|
8
|
-
|
|
9
|
-
## Type Aliases
|
|
10
|
-
|
|
11
|
-
- [RandomPropertyEntity](type-aliases/RandomPropertyEntity.md)
|
|
12
|
-
|
|
13
|
-
## Functions
|
|
14
|
-
|
|
15
|
-
- [randomPropertyEntity](functions/randomPropertyEntity.md)
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [utils/data-property-entity](../index.md) / RandomPropertyEntity
|
|
6
|
-
|
|
7
|
-
# Type Alias: RandomPropertyEntity()
|
|
8
|
-
|
|
9
|
-
> **RandomPropertyEntity**: (`options`) => `Partial`\<[`IPropertyEntity`](../../../properties/i-property-entity/interfaces/IPropertyEntity.md)\>
|
|
10
|
-
|
|
11
|
-
Defined in: [utils/data-property-entity.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/utils/data-property-entity.ts#L6)
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
### options
|
|
16
|
-
|
|
17
|
-
[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md)
|
|
18
|
-
|
|
19
|
-
## Returns
|
|
20
|
-
|
|
21
|
-
`Partial`\<[`IPropertyEntity`](../../../properties/i-property-entity/interfaces/IPropertyEntity.md)\>
|