realty-investor-timeline

@cubedelement.com/realty-investor-timeline

---

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

Interface: IReasonToRule<T, TR>

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

Extends

• IReasonToRuleMeta<TR>

Type Parameters

• T extends IRentalPropertyEntity

• TR extends PurchaseRuleTypes | HoldRuleTypes

Properties

investmentReason

investmentReason: InvestmentReasons

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

Inherited from

IReasonToRuleMeta.investmentReason

---

isRuleAndPropertyTypeMatch()

isRuleAndPropertyTypeMatch: (propertyType, ruleType) => boolean

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

Parameters

propertyType

PropertyType

ruleType

TR

Returns

boolean

---

isRuleMatch()

isRuleMatch: (ruleType) => boolean

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

Parameters

ruleType

TR

Returns

boolean

---

propertyKey

propertyKey: keyof T & string

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

---

propertyType

propertyType: PropertyType

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

---

ruleType?

optional ruleType: TR

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

Inherited from

IReasonToRuleMeta.ruleType

---

values

values: number[]

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

Methods

getValueAtIndex()

getValueAtIndex(index): number

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

Parameters

index

number

Returns

number

---

isRuleNone()

isRuleNone(): boolean

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

Returns

boolean

---

isValueGreater()

isValueGreater<T2>(rule): boolean

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

Type Parameters

• T2 extends IRentalPropertyEntity

Parameters

rule

IReasonToRule<T2, TR>

Returns

boolean

---

userResultEstimates()

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

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

Parameters

rental

IRentalPropertyEntity

holdRules

IRuleEvaluation<HoldRuleTypes>[]

purchaseRules

IRuleEvaluation<PurchaseRuleTypes>[]

date

Date

Returns

UserInvestResult[]

This site is open source. Improve this page.