realty-investor-timeline

@cubedelement.com/realty-investor-timeline


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

Interface: IUser

Defined in: account/user.ts:16

It’s the user… as an interface!

Extends

Properties

holdRules

holdRules: IRuleEvaluation<HoldRuleTypes>[]

Defined in: account/i-user-investor-check.ts:23

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

Inherited from

IUserInvestorCheck.holdRules


ledgerCollection

readonly ledgerCollection: ILedgerCollection

Defined in: account/i-user-investor-check.ts:13

the collection which is used to keep a balance sheet.

Inherited from

IUserInvestorCheck.ledgerCollection


loanSettings

loanSettings: ILoanSetting[]

Defined in: account/i-user-investor-check.ts:18

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

Inherited from

IUserInvestorCheck.loanSettings


monthlyIncomeAmountGoal

monthlyIncomeAmountGoal: number

Defined in: account/i-user-goal.ts:5

used to determine how much you need want for monthly expenses

Inherited from

IUserInvestorCheck.monthlyIncomeAmountGoal


monthlySavedAmount

monthlySavedAmount: number

Defined in: account/user.ts:20

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


purchaseRules

purchaseRules: IRuleEvaluation<PurchaseRuleTypes>[]

Defined in: account/i-user-investor-check.ts:60

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

Inherited from

IUserInvestorCheck.purchaseRules

Methods

clone()

clone(): IUser

Defined in: account/user.ts:34

Returns

IUser


getAvailableSavings()

getAvailableSavings(date, properties): number

Defined in: account/i-user-investor-check.ts:55

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

Inherited from

IUserInvestorCheck.getAvailableSavings


getCashFlowMonth()

getCashFlowMonth(today): number

Defined in: account/user.ts:26

returns your passive income for the year + month date supplied

Parameters

today

Date

Returns

number


getCashFlowQuarter()

getCashFlowQuarter(today): number

Defined in: account/user.ts:32

returns the cash flow by a quarter. This is ideal when evaluating your distributions that are not monthly.

Parameters

today

Date

Returns

number


getMinimumSavings()

getMinimumSavings(date, properties): number

Defined in: account/i-user-investor-check.ts:48

used to retrieve the amount required to keep in savings

Parameters

date

Date

properties

IRentalPropertyEntity[]

Returns

number

Inherited from

IUserInvestorCheck.getMinimumSavings


hasMinimumSavings()

hasMinimumSavings(date, properties): boolean

Defined in: account/i-user-investor-check.ts:41

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

Inherited from

IUserInvestorCheck.hasMinimumSavings


hasMoneyToInvest()

hasMoneyToInvest(date, properties, contribution?): boolean

Defined in: account/i-user-investor-check.ts:33

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;

Inherited from

IUserInvestorCheck.hasMoneyToInvest


metAverageQuarterlyGoal()

metAverageQuarterlyGoal(today): boolean

Defined in: account/i-user-goal.ts:17

takes data from a quarterly average cash flow and compares it to the monthly goal. The reason on quarterly is that apartments do distributions quarterly, so you have to spread those out monthly

Parameters

today

Date

Returns

boolean

Inherited from

IUserInvestorCheck.metAverageQuarterlyGoal


metMonthlyGoal()

metMonthlyGoal(today): boolean

Defined in: account/i-user-goal.ts:11

method used to help determine if you have met your expenses

Parameters

today

Date

Returns

boolean

Inherited from

IUserInvestorCheck.metMonthlyGoal