realty-investor-timeline

@cubedelement.com/realty-investor-timeline

---

@cubedelement.com/realty-investor-timeline / investments/reason-to-rule / ReasonToRule

Class: ReasonToRule<T, TR>

Defined in: investments/reason-to-rule.ts:39

Type Parameters

• T extends IRentalPropertyEntity

• TR extends PurchaseRuleTypes | HoldRuleTypes

Implements

• IReasonToRule<T, TR>

Constructors

new ReasonToRule()

new ReasonToRule<T, TR>(investmentReason, propertyType, propertyKey, value, ruleType?, overrideUserResultEstimates?): ReasonToRule<T, TR>

Defined in: investments/reason-to-rule.ts:44

Parameters

investmentReason

InvestmentReasons

propertyType

PropertyType

propertyKey

keyof T & string

value

number[]

ruleType?

TR

overrideUserResultEstimates?

UserResultEstimates

Returns

ReasonToRule<T, TR>

Properties

investmentReason

investmentReason: InvestmentReasons

Defined in: investments/reason-to-rule.ts:84

Implementation of

IReasonToRule.investmentReason

---

propertyKey

propertyKey: keyof T & string

Defined in: investments/reason-to-rule.ts:129

Implementation of

IReasonToRule.propertyKey

---

propertyType

propertyType: PropertyType

Defined in: investments/reason-to-rule.ts:130

Implementation of

IReasonToRule.propertyType

---

ruleType

ruleType: TR

Defined in: investments/reason-to-rule.ts:131

Implementation of

IReasonToRule.ruleType

---

values

values: number[]

Defined in: investments/reason-to-rule.ts:132

Implementation of

IReasonToRule.values

Methods

getValueAtIndex()

getValueAtIndex(index): number

Defined in: investments/reason-to-rule.ts:98

Parameters

index

number

Returns

number

Implementation of

IReasonToRule.getValueAtIndex

---

isRuleAndPropertyTypeMatch()

isRuleAndPropertyTypeMatch(propertyType, ruleType): boolean

Defined in: investments/reason-to-rule.ts:86

Parameters

propertyType

PropertyType

ruleType

TR

Returns

boolean

Implementation of

IReasonToRule.isRuleAndPropertyTypeMatch

---

isRuleMatch()

isRuleMatch(ruleType): boolean

Defined in: investments/reason-to-rule.ts:90

Parameters

ruleType

TR

Returns

boolean

Implementation of

IReasonToRule.isRuleMatch

---

isRuleNone()

isRuleNone(): boolean

Defined in: investments/reason-to-rule.ts:94

Returns

boolean

Implementation of

IReasonToRule.isRuleNone

---

isValueGreater()

isValueGreater<T2>(rule): boolean

Defined in: investments/reason-to-rule.ts:60

Type Parameters

• T2 extends IRentalPropertyEntity

Parameters

rule

IReasonToRule<T2, TR>

Returns

boolean

Implementation of

IReasonToRule.isValueGreater

---

userResultEstimates()

userResultEstimates(rental, holdRules, purchaseRules, date): UserInvestResult[]

Defined in: investments/reason-to-rule.ts:106

Parameters

rental

IRentalPropertyEntity

holdRules

IRuleEvaluation<HoldRuleTypes>[]

purchaseRules

IRuleEvaluation<PurchaseRuleTypes>[]

date

Date

Returns

UserInvestResult[]

Implementation of

IReasonToRule.userResultEstimates

This site is open source. Improve this page.