@cubedelement.com/realty-investor-timeline 5.5.1 → 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 +7 -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/ledger/ledger-collection.d.ts +4 -0
- package/dist/src/ledger/ledger-collection.js +43 -0
- 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/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,25 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/eval-types](../index.md) / AtLeastOrMore
|
|
6
|
-
|
|
7
|
-
# Function: AtLeastOrMore()
|
|
8
|
-
|
|
9
|
-
> **AtLeastOrMore**(`value1`, `value2`): `boolean`
|
|
10
|
-
|
|
11
|
-
Defined in: [rules/eval-types.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/eval-types.ts#L5)
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
### value1
|
|
16
|
-
|
|
17
|
-
`number`
|
|
18
|
-
|
|
19
|
-
### value2
|
|
20
|
-
|
|
21
|
-
`number`
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
`boolean`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/eval-types](../index.md) / NoMoreThan
|
|
6
|
-
|
|
7
|
-
# Function: NoMoreThan()
|
|
8
|
-
|
|
9
|
-
> **NoMoreThan**(`value1`, `value2`): `boolean`
|
|
10
|
-
|
|
11
|
-
Defined in: [rules/eval-types.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/eval-types.ts#L3)
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
### value1
|
|
16
|
-
|
|
17
|
-
`number`
|
|
18
|
-
|
|
19
|
-
### value2
|
|
20
|
-
|
|
21
|
-
`number`
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
`boolean`
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / rules/eval-types
|
|
6
|
-
|
|
7
|
-
# rules/eval-types
|
|
8
|
-
|
|
9
|
-
## Functions
|
|
10
|
-
|
|
11
|
-
- [AtLeastOrMore](functions/AtLeastOrMore.md)
|
|
12
|
-
- [NoMoreThan](functions/NoMoreThan.md)
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/get-enum-type-by-value](../index.md) / getEnumTypeByValue
|
|
6
|
-
|
|
7
|
-
# Function: getEnumTypeByValue()
|
|
8
|
-
|
|
9
|
-
> **getEnumTypeByValue**(`value`): `"None"` \| `"PurchaseRuleTypes"` \| `"HoldRuleTypes"`
|
|
10
|
-
|
|
11
|
-
Defined in: [rules/get-enum-type-by-value.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/get-enum-type-by-value.ts#L8)
|
|
12
|
-
|
|
13
|
-
Used to help determine from a string if the value is in one of the enums
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### value
|
|
18
|
-
|
|
19
|
-
`string`
|
|
20
|
-
|
|
21
|
-
## Returns
|
|
22
|
-
|
|
23
|
-
`"None"` \| `"PurchaseRuleTypes"` \| `"HoldRuleTypes"`
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / rules/get-enum-type-by-value
|
|
6
|
-
|
|
7
|
-
# rules/get-enum-type-by-value
|
|
8
|
-
|
|
9
|
-
## Functions
|
|
10
|
-
|
|
11
|
-
- [getEnumTypeByValue](functions/getEnumTypeByValue.md)
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/get-rules](../index.md) / getRules
|
|
6
|
-
|
|
7
|
-
# Function: getRules()
|
|
8
|
-
|
|
9
|
-
> **getRules**\<`E`\>(`goals`): [`IRuleEvaluation`](../../rule-evaluation/interfaces/IRuleEvaluation.md)\<`E`\>[]
|
|
10
|
-
|
|
11
|
-
Defined in: [rules/get-rules.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/get-rules.ts#L10)
|
|
12
|
-
|
|
13
|
-
provides a way to translate the [IRule](../../i-rule/interfaces/IRule.md) into a [RuleEvaluation](../../rule-evaluation/classes/RuleEvaluation.md) instance
|
|
14
|
-
|
|
15
|
-
## Type Parameters
|
|
16
|
-
|
|
17
|
-
• **E** _extends_ [`PurchaseRuleTypes`](../../purchase-rule-types/enumerations/PurchaseRuleTypes.md) \| [`HoldRuleTypes`](../../hold-rule-types/enumerations/HoldRuleTypes.md)
|
|
18
|
-
|
|
19
|
-
## Parameters
|
|
20
|
-
|
|
21
|
-
### goals
|
|
22
|
-
|
|
23
|
-
[`IRule`](../../i-rule/interfaces/IRule.md)\<`E`\>[]
|
|
24
|
-
|
|
25
|
-
## Returns
|
|
26
|
-
|
|
27
|
-
[`IRuleEvaluation`](../../rule-evaluation/interfaces/IRuleEvaluation.md)\<`E`\>[]
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/hold-rule-types](../index.md) / HoldRuleTypes
|
|
6
|
-
|
|
7
|
-
# Enumeration: HoldRuleTypes
|
|
8
|
-
|
|
9
|
-
Defined in: [rules/hold-rule-types.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/hold-rule-types.ts#L1)
|
|
10
|
-
|
|
11
|
-
## Enumeration Members
|
|
12
|
-
|
|
13
|
-
### MinSellIfHighEquityPercent
|
|
14
|
-
|
|
15
|
-
> **MinSellIfHighEquityPercent**: `"minSellIfHighEquityPercent"`
|
|
16
|
-
|
|
17
|
-
Defined in: [rules/hold-rule-types.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/hold-rule-types.ts#L14)
|
|
18
|
-
|
|
19
|
-
this rule states if you have high equity capture, then you'd like to sell it. This is like Unrealized Capital Gain
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
### MinSellIfLowCashFlowPercent
|
|
24
|
-
|
|
25
|
-
> **MinSellIfLowCashFlowPercent**: `"minSellIfLowCashFlowPercent"`
|
|
26
|
-
|
|
27
|
-
Defined in: [rules/hold-rule-types.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/hold-rule-types.ts#L9)
|
|
28
|
-
|
|
29
|
-
this rule states that if you have a low cash flow %, then you'd like to sell it
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
### MinSellInYears
|
|
34
|
-
|
|
35
|
-
> **MinSellInYears**: `"minSellInYears"`
|
|
36
|
-
|
|
37
|
-
Defined in: [rules/hold-rule-types.ts:19](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/hold-rule-types.ts#L19)
|
|
38
|
-
|
|
39
|
-
this rule states if you reach an x number of years, then you'd like to sell it
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
### None
|
|
44
|
-
|
|
45
|
-
> **None**: `"none"`
|
|
46
|
-
|
|
47
|
-
Defined in: [rules/hold-rule-types.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/hold-rule-types.ts#L5)
|
|
48
|
-
|
|
49
|
-
no rule
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / rules/hold-rule-types
|
|
6
|
-
|
|
7
|
-
# rules/hold-rule-types
|
|
8
|
-
|
|
9
|
-
## Enumerations
|
|
10
|
-
|
|
11
|
-
- [HoldRuleTypes](enumerations/HoldRuleTypes.md)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/i-rule](../index.md) / IRule
|
|
6
|
-
|
|
7
|
-
# Interface: IRule\<E\>
|
|
8
|
-
|
|
9
|
-
Defined in: [rules/i-rule.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/i-rule.ts#L3)
|
|
10
|
-
|
|
11
|
-
## Extended by
|
|
12
|
-
|
|
13
|
-
- [`IRuleEvaluation`](../../rule-evaluation/interfaces/IRuleEvaluation.md)
|
|
14
|
-
|
|
15
|
-
## Type Parameters
|
|
16
|
-
|
|
17
|
-
• **E**
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### propertyType
|
|
22
|
-
|
|
23
|
-
> **propertyType**: [`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
|
|
24
|
-
|
|
25
|
-
Defined in: [rules/i-rule.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/i-rule.ts#L6)
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
### type
|
|
30
|
-
|
|
31
|
-
> **type**: `E`
|
|
32
|
-
|
|
33
|
-
Defined in: [rules/i-rule.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/i-rule.ts#L4)
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
### value
|
|
38
|
-
|
|
39
|
-
> **value**: `number`
|
|
40
|
-
|
|
41
|
-
Defined in: [rules/i-rule.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/i-rule.ts#L5)
|
package/docs/rules/index.md
DELETED
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../modules.md) / rules
|
|
6
|
-
|
|
7
|
-
# rules
|
|
8
|
-
|
|
9
|
-
## References
|
|
10
|
-
|
|
11
|
-
### AtLeastOrMore
|
|
12
|
-
|
|
13
|
-
Re-exports [AtLeastOrMore](eval-types/functions/AtLeastOrMore.md)
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
### EvalType
|
|
18
|
-
|
|
19
|
-
Re-exports [EvalType](eval-type/type-aliases/EvalType.md)
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
### getEnumTypeByValue
|
|
24
|
-
|
|
25
|
-
Re-exports [getEnumTypeByValue](get-enum-type-by-value/functions/getEnumTypeByValue.md)
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
### getRules
|
|
30
|
-
|
|
31
|
-
Re-exports [getRules](get-rules/functions/getRules.md)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### HoldRuleTypes
|
|
36
|
-
|
|
37
|
-
Re-exports [HoldRuleTypes](hold-rule-types/enumerations/HoldRuleTypes.md)
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
### IRule
|
|
42
|
-
|
|
43
|
-
Re-exports [IRule](i-rule/interfaces/IRule.md)
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
### IRuleEvaluation
|
|
48
|
-
|
|
49
|
-
Re-exports [IRuleEvaluation](rule-evaluation/interfaces/IRuleEvaluation.md)
|
|
50
|
-
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
### NoMoreThan
|
|
54
|
-
|
|
55
|
-
Re-exports [NoMoreThan](eval-types/functions/NoMoreThan.md)
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
### PurchaseRuleTypes
|
|
60
|
-
|
|
61
|
-
Re-exports [PurchaseRuleTypes](purchase-rule-types/enumerations/PurchaseRuleTypes.md)
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
### RuleEvaluation
|
|
66
|
-
|
|
67
|
-
Re-exports [RuleEvaluation](rule-evaluation/classes/RuleEvaluation.md)
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/purchase-rule-types](../index.md) / PurchaseRuleTypes
|
|
6
|
-
|
|
7
|
-
# Enumeration: PurchaseRuleTypes
|
|
8
|
-
|
|
9
|
-
Defined in: [rules/purchase-rule-types.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L1)
|
|
10
|
-
|
|
11
|
-
## Enumeration Members
|
|
12
|
-
|
|
13
|
-
### MaxEstimatedOutOfPocket
|
|
14
|
-
|
|
15
|
-
> **MaxEstimatedOutOfPocket**: `"maxEstimatedOutOfPocket"`
|
|
16
|
-
|
|
17
|
-
Defined in: [rules/purchase-rule-types.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L17)
|
|
18
|
-
|
|
19
|
-
implemented on SingleFamily and RentalPassiveApartment.
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
### MinAfterRepairPrice
|
|
24
|
-
|
|
25
|
-
> **MinAfterRepairPrice**: `"minAfterRepairPrice"`
|
|
26
|
-
|
|
27
|
-
Defined in: [rules/purchase-rule-types.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L7)
|
|
28
|
-
|
|
29
|
-
not implemented
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
### MinAskingPrice
|
|
34
|
-
|
|
35
|
-
> **MinAskingPrice**: `"minAskingPrice"`
|
|
36
|
-
|
|
37
|
-
Defined in: [rules/purchase-rule-types.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L12)
|
|
38
|
-
|
|
39
|
-
implemented on SingleFamily
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
### MinEstimatedAnnualCashFlow
|
|
44
|
-
|
|
45
|
-
> **MinEstimatedAnnualCashFlow**: `"minEstimatedAnnualCashFlow"`
|
|
46
|
-
|
|
47
|
-
Defined in: [rules/purchase-rule-types.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L23)
|
|
48
|
-
|
|
49
|
-
implemented on SingleFamily and RentalPassiveApartment. Note: monthly cash flow for Single family
|
|
50
|
-
while quarterly for passive apartments
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
### MinEstimatedCapitalGainsPercent
|
|
55
|
-
|
|
56
|
-
> **MinEstimatedCapitalGainsPercent**: `"minEstimatedCapitalGainsPercent"`
|
|
57
|
-
|
|
58
|
-
Defined in: [rules/purchase-rule-types.ts:33](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L33)
|
|
59
|
-
|
|
60
|
-
implemented for SingleFamily and RentalPassiveApartment.
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
### MinEstimatedCashOnCashPercent
|
|
65
|
-
|
|
66
|
-
> **MinEstimatedCashOnCashPercent**: `"minEstimatedCashOnCashPercent"`
|
|
67
|
-
|
|
68
|
-
Defined in: [rules/purchase-rule-types.ts:28](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L28)
|
|
69
|
-
|
|
70
|
-
implemented on SingleFamily and RentalPassiveApartment. An estimation used to determine cash on cash percent
|
|
71
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
### None
|
|
75
|
-
|
|
76
|
-
> **None**: `"none"`
|
|
77
|
-
|
|
78
|
-
Defined in: [rules/purchase-rule-types.ts:2](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/purchase-rule-types.ts#L2)
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / rules/purchase-rule-types
|
|
6
|
-
|
|
7
|
-
# rules/purchase-rule-types
|
|
8
|
-
|
|
9
|
-
## Enumerations
|
|
10
|
-
|
|
11
|
-
- [PurchaseRuleTypes](enumerations/PurchaseRuleTypes.md)
|
|
@@ -1,103 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/rule-evaluation](../index.md) / RuleEvaluation
|
|
6
|
-
|
|
7
|
-
# Class: RuleEvaluation\<E\>
|
|
8
|
-
|
|
9
|
-
Defined in: [rules/rule-evaluation.ts:15](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L15)
|
|
10
|
-
|
|
11
|
-
## Type Parameters
|
|
12
|
-
|
|
13
|
-
• **E** _extends_ [`PurchaseRuleTypes`](../../purchase-rule-types/enumerations/PurchaseRuleTypes.md) \| [`HoldRuleTypes`](../../hold-rule-types/enumerations/HoldRuleTypes.md)
|
|
14
|
-
|
|
15
|
-
## Implements
|
|
16
|
-
|
|
17
|
-
- [`IRuleEvaluation`](../interfaces/IRuleEvaluation.md)\<`E`\>
|
|
18
|
-
|
|
19
|
-
## Constructors
|
|
20
|
-
|
|
21
|
-
### new RuleEvaluation()
|
|
22
|
-
|
|
23
|
-
> **new RuleEvaluation**\<`E`\>(`value`, `type`, `propertyType`): [`RuleEvaluation`](RuleEvaluation.md)\<`E`\>
|
|
24
|
-
|
|
25
|
-
Defined in: [rules/rule-evaluation.ts:16](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L16)
|
|
26
|
-
|
|
27
|
-
#### Parameters
|
|
28
|
-
|
|
29
|
-
##### value
|
|
30
|
-
|
|
31
|
-
`number`
|
|
32
|
-
|
|
33
|
-
##### type
|
|
34
|
-
|
|
35
|
-
`E`
|
|
36
|
-
|
|
37
|
-
##### propertyType
|
|
38
|
-
|
|
39
|
-
[`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
|
|
40
|
-
|
|
41
|
-
#### Returns
|
|
42
|
-
|
|
43
|
-
[`RuleEvaluation`](RuleEvaluation.md)\<`E`\>
|
|
44
|
-
|
|
45
|
-
## Properties
|
|
46
|
-
|
|
47
|
-
### propertyType
|
|
48
|
-
|
|
49
|
-
> **propertyType**: [`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
|
|
50
|
-
|
|
51
|
-
Defined in: [rules/rule-evaluation.ts:24](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L24)
|
|
52
|
-
|
|
53
|
-
#### Implementation of
|
|
54
|
-
|
|
55
|
-
[`IRuleEvaluation`](../interfaces/IRuleEvaluation.md).[`propertyType`](../interfaces/IRuleEvaluation.md#propertytype)
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
### type
|
|
60
|
-
|
|
61
|
-
> **type**: `E`
|
|
62
|
-
|
|
63
|
-
Defined in: [rules/rule-evaluation.ts:22](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L22)
|
|
64
|
-
|
|
65
|
-
#### Implementation of
|
|
66
|
-
|
|
67
|
-
[`IRuleEvaluation`](../interfaces/IRuleEvaluation.md).[`type`](../interfaces/IRuleEvaluation.md#type)
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
### value
|
|
72
|
-
|
|
73
|
-
> **value**: `number`
|
|
74
|
-
|
|
75
|
-
Defined in: [rules/rule-evaluation.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L23)
|
|
76
|
-
|
|
77
|
-
#### Implementation of
|
|
78
|
-
|
|
79
|
-
[`IRuleEvaluation`](../interfaces/IRuleEvaluation.md).[`value`](../interfaces/IRuleEvaluation.md#value)
|
|
80
|
-
|
|
81
|
-
## Methods
|
|
82
|
-
|
|
83
|
-
### evaluate()
|
|
84
|
-
|
|
85
|
-
> **evaluate**(`dataValue`): `boolean`
|
|
86
|
-
|
|
87
|
-
Defined in: [rules/rule-evaluation.ts:30](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L30)
|
|
88
|
-
|
|
89
|
-
Determines if the [dataValue](RuleEvaluation.md#datavalue) passes the rule
|
|
90
|
-
|
|
91
|
-
#### Parameters
|
|
92
|
-
|
|
93
|
-
##### dataValue
|
|
94
|
-
|
|
95
|
-
`number`
|
|
96
|
-
|
|
97
|
-
#### Returns
|
|
98
|
-
|
|
99
|
-
`boolean`
|
|
100
|
-
|
|
101
|
-
#### Implementation of
|
|
102
|
-
|
|
103
|
-
[`IRuleEvaluation`](../interfaces/IRuleEvaluation.md).[`evaluate`](../interfaces/IRuleEvaluation.md#evaluate)
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / rules/rule-evaluation
|
|
6
|
-
|
|
7
|
-
# rules/rule-evaluation
|
|
8
|
-
|
|
9
|
-
## Classes
|
|
10
|
-
|
|
11
|
-
- [RuleEvaluation](classes/RuleEvaluation.md)
|
|
12
|
-
|
|
13
|
-
## Interfaces
|
|
14
|
-
|
|
15
|
-
- [IRuleEvaluation](interfaces/IRuleEvaluation.md)
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [rules/rule-evaluation](../index.md) / IRuleEvaluation
|
|
6
|
-
|
|
7
|
-
# Interface: IRuleEvaluation\<E\>
|
|
8
|
-
|
|
9
|
-
Defined in: [rules/rule-evaluation.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L7)
|
|
10
|
-
|
|
11
|
-
## Extends
|
|
12
|
-
|
|
13
|
-
- [`IRule`](../../i-rule/interfaces/IRule.md)\<`E`\>
|
|
14
|
-
|
|
15
|
-
## Type Parameters
|
|
16
|
-
|
|
17
|
-
• **E** _extends_ [`PurchaseRuleTypes`](../../purchase-rule-types/enumerations/PurchaseRuleTypes.md) \| [`HoldRuleTypes`](../../hold-rule-types/enumerations/HoldRuleTypes.md)
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### propertyType
|
|
22
|
-
|
|
23
|
-
> **propertyType**: [`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
|
|
24
|
-
|
|
25
|
-
Defined in: [rules/i-rule.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/i-rule.ts#L6)
|
|
26
|
-
|
|
27
|
-
#### Inherited from
|
|
28
|
-
|
|
29
|
-
[`IRule`](../../i-rule/interfaces/IRule.md).[`propertyType`](../../i-rule/interfaces/IRule.md#propertytype)
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
### type
|
|
34
|
-
|
|
35
|
-
> **type**: `E`
|
|
36
|
-
|
|
37
|
-
Defined in: [rules/i-rule.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/i-rule.ts#L4)
|
|
38
|
-
|
|
39
|
-
#### Inherited from
|
|
40
|
-
|
|
41
|
-
[`IRule`](../../i-rule/interfaces/IRule.md).[`type`](../../i-rule/interfaces/IRule.md#type)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
### value
|
|
46
|
-
|
|
47
|
-
> **value**: `number`
|
|
48
|
-
|
|
49
|
-
Defined in: [rules/i-rule.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/i-rule.ts#L5)
|
|
50
|
-
|
|
51
|
-
#### Inherited from
|
|
52
|
-
|
|
53
|
-
[`IRule`](../../i-rule/interfaces/IRule.md).[`value`](../../i-rule/interfaces/IRule.md#value)
|
|
54
|
-
|
|
55
|
-
## Methods
|
|
56
|
-
|
|
57
|
-
### evaluate()
|
|
58
|
-
|
|
59
|
-
> **evaluate**(`dataValue`): `boolean`
|
|
60
|
-
|
|
61
|
-
Defined in: [rules/rule-evaluation.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/rules/rule-evaluation.ts#L12)
|
|
62
|
-
|
|
63
|
-
Determines if the [dataValue](IRuleEvaluation.md#datavalue) passes the rule
|
|
64
|
-
|
|
65
|
-
#### Parameters
|
|
66
|
-
|
|
67
|
-
##### dataValue
|
|
68
|
-
|
|
69
|
-
`number`
|
|
70
|
-
|
|
71
|
-
#### Returns
|
|
72
|
-
|
|
73
|
-
`boolean`
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/default-has-met-goal-or-max-time](../index.md) / defaultHasMetGoalOrMaxTime
|
|
6
|
-
|
|
7
|
-
# Function: defaultHasMetGoalOrMaxTime()
|
|
8
|
-
|
|
9
|
-
> **defaultHasMetGoalOrMaxTime**(`start`, `today`, `user`, `rentals`, `maxYears`): `boolean`
|
|
10
|
-
|
|
11
|
-
Defined in: [time/default-has-met-goal-or-max-time.ts:15](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/default-has-met-goal-or-max-time.ts#L15)
|
|
12
|
-
|
|
13
|
-
Method will compare basic dates w/ null user and all rentals
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
### start
|
|
18
|
-
|
|
19
|
-
`Date`
|
|
20
|
-
|
|
21
|
-
### today
|
|
22
|
-
|
|
23
|
-
`Date`
|
|
24
|
-
|
|
25
|
-
### user
|
|
26
|
-
|
|
27
|
-
[`IUser`](../../../account/user/interfaces/IUser.md)
|
|
28
|
-
|
|
29
|
-
### rentals
|
|
30
|
-
|
|
31
|
-
[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
|
|
32
|
-
|
|
33
|
-
### maxYears
|
|
34
|
-
|
|
35
|
-
`number`
|
|
36
|
-
|
|
37
|
-
## Returns
|
|
38
|
-
|
|
39
|
-
`boolean`
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
[**@cubedelement.com/realty-investor-timeline**](../../index.md)
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/default-has-met-goal-or-max-time
|
|
6
|
-
|
|
7
|
-
# time/default-has-met-goal-or-max-time
|
|
8
|
-
|
|
9
|
-
## Functions
|
|
10
|
-
|
|
11
|
-
- [defaultHasMetGoalOrMaxTime](functions/defaultHasMetGoalOrMaxTime.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/has-met-goal-or-max-time
|
|
6
|
-
|
|
7
|
-
# time/has-met-goal-or-max-time
|
|
8
|
-
|
|
9
|
-
## Type Aliases
|
|
10
|
-
|
|
11
|
-
- [HasMetGoalOrMaxTime](type-aliases/HasMetGoalOrMaxTime.md)
|