realty-investor-timeline

@cubedelement.com/realty-investor-timeline


@cubedelement.com/realty-investor-timeline / account/user / User

Class: User

Defined in: account/user.ts:32

It’s the user… as an interface!

Implements

Constructors

new User()

new User(ledgerCollection): User

Defined in: account/user.ts:75

Parameters

ledgerCollection

ILedgerCollection

Returns

User

Properties

holdRules

holdRules: IRuleEvaluation<HoldRuleTypes>[]

Defined in: account/user.ts:82

a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule

Implementation of

IUser.holdRules


ledgerCollection

readonly ledgerCollection: ILedgerCollection

Defined in: account/user.ts:36

the collection which is used to keep a balance sheet.

Implementation of

IUser.ledgerCollection


loanSettings

loanSettings: ILoanSetting[]

Defined in: account/user.ts:41

a collection of loan settings for how to get a loan for single family or some other kind of property

Implementation of

IUser.loanSettings


monthlyIncomeAmountGoal

monthlyIncomeAmountGoal: number

Defined in: account/user.ts:46

used to determine how much you need want for monthly expenses

Implementation of

IUser.monthlyIncomeAmountGoal


monthlySavedAmount

monthlySavedAmount: number

Defined in: account/user.ts:73

an amount which the user can save per month after expenses, like, after my pay check I could put this amount into savings

Implementation of

IUser.monthlySavedAmount


purchaseRules

purchaseRules: IRuleEvaluation<PurchaseRuleTypes>[]

Defined in: account/user.ts:87

a system to weed out the properties you don’t want. This scenario says as long as it meets 1 rule

Implementation of

IUser.purchaseRules

Methods

clone()

clone(): IUser

Defined in: account/user.ts:171

Returns

IUser

Implementation of

IUser.clone


getAvailableSavings()

getAvailableSavings(date, properties): number

Defined in: account/user.ts:155

should be the total balance - savings, using getMinimumSavings, for determining monthly cash to save for single family properties

Parameters

date

Date

properties

IRentalPropertyEntity[]

Returns

number

Implementation of

IUser.getAvailableSavings


getEstimatedMonthlyCashFlow()

getEstimatedMonthlyCashFlow(today, properties): number

Defined in: account/user.ts:57

method used to help determine if you have met your expenses

Parameters

today

Date

properties

IRentalPropertyEntity[]

Returns

number

Implementation of

IUser.getEstimatedMonthlyCashFlow


getMinimumSavings()

getMinimumSavings(date, properties): number

Defined in: account/user.ts:137

used to retrieve the amount required to keep in savings

Parameters

date

Date

properties

IRentalPropertyEntity[]

Returns

number

Implementation of

IUser.getMinimumSavings


hasMinimumSavings()

hasMinimumSavings(date, properties): boolean

Defined in: account/user.ts:119

a way to determine if the user has enough money. This is different because with single family homes, you would have to save a certain amount of monthly mortgage

Parameters

date

Date

properties

IRentalPropertyEntity[]

Returns

boolean

Implementation of

IUser.hasMinimumSavings


hasMoneyToInvest()

hasMoneyToInvest(date, properties, contribution?): boolean

Defined in: account/user.ts:97

based upon getMinimumSavings, it checks to see if there is an amount remaining that can be used along with the contribution.

Parameters

date

Date

properties

IRentalPropertyEntity[]

contribution?

number

Returns

boolean

Example

availableSavings - contribution >= 0;

Implementation of

IUser.hasMoneyToInvest


metMonthlyGoal()

metMonthlyGoal(today, properties): boolean

Defined in: account/user.ts:53

method used to help determine if you have met your expenses

Parameters

today

Date

properties

IRentalPropertyEntity[]

Returns

boolean

Implementation of

IUser.metMonthlyGoal