realty-investor-timeline

@cubedelement.com/realty-investor-timeline

---

@cubedelement.com/realty-investor-timeline / ledger/ledger-collection / LedgerCollection

Class: LedgerCollection

Defined in: ledger/ledger-collection.ts:86

Implements

• ILedgerCollection

Constructors

Constructor

new LedgerCollection(): LedgerCollection

Defined in: ledger/ledger-collection.ts:98

Returns

LedgerCollection

Methods

add()

add(item): void

Defined in: ledger/ledger-collection.ts:128

Parameters

item

LedgerItem | Iterable<LedgerItem, any, any>

Returns

void

Implementation of

ILedgerCollection.add

---

clone()

clone(): ILedgerCollection

Defined in: ledger/ledger-collection.ts:419

Returns

ILedgerCollection

Implementation of

ILedgerCollection.clone

---

filter()

filter(pred?): LedgerItem[]

Defined in: ledger/ledger-collection.ts:102

Parameters

pred?

LedgerItemPredicate

Returns

LedgerItem[]

Implementation of

ILedgerCollection.filter

---

getAvailableSavings()

getAvailableSavings(date, properties, minMonthsRequired?): number

Defined in: ledger/ledger-collection.ts:397

should be the total balance - savings for single family

Parameters

date

Date

properties

IRentalPropertyEntity[]

minMonthsRequired?

number = 6

Returns

number

Implementation of

ILedgerCollection.getAvailableSavings

---

getAverageByType()

getAverageByType(collection, type): number

Defined in: ledger/ledger-collection.ts:181

Parameters

collection

LedgerItem[]

type

LedgerItemType

Returns

number

---

getAverageCashFlowMonthByQuarter()

getAverageCashFlowMonthByQuarter(date?): number

Defined in: ledger/ledger-collection.ts:238

Parameters

date?

Date

Returns

number

Implementation of

ILedgerCollection.getAverageCashFlowMonthByQuarter

---

getBalance()

getBalance(date?): number

Defined in: ledger/ledger-collection.ts:118

the total balance in the ledger collection

Parameters

date?

Date

Returns

number

Implementation of

ILedgerCollection.getBalance

---

getCashFlowMonth()

getCashFlowMonth(date?): number

Defined in: ledger/ledger-collection.ts:220

Parameters

date?

Date

Returns

number

Implementation of

ILedgerCollection.getCashFlowMonth

---

getCashFlowQuarter()

getCashFlowQuarter(date?): number

Defined in: ledger/ledger-collection.ts:272

Parameters

date?

Date

Returns

number

Implementation of

ILedgerCollection.getCashFlowQuarter

---

getCashFlowYearAverage()

getCashFlowYearAverage(date?): number

Defined in: ledger/ledger-collection.ts:202

used to get the average cash flow for the year.

Parameters

date?

Date

Returns

number

Implementation of

ILedgerCollection.getCashFlowYearAverage

---

getLastLedgerMonth()

getLastLedgerMonth(): LedgerItem[]

Defined in: ledger/ledger-collection.ts:409

Returns

LedgerItem[]

Implementation of

ILedgerCollection.getLastLedgerMonth

---

getLatestLedgerItem()

getLatestLedgerItem(): LedgerItem

Defined in: ledger/ledger-collection.ts:401

Returns

LedgerItem

Implementation of

ILedgerCollection.getLatestLedgerItem

---

getMinimumSavings()

getMinimumSavings(properties, date, minMonthsRequired?): number

Defined in: ledger/ledger-collection.ts:151

This method gets the total of savings needed for all properties by x amount of months.

Parameters

properties

IRentalPropertyEntity[]

date

Date

minMonthsRequired?

number = 6

Returns

number

Examples

Example, you typically need 6 months of month per single family home, so if you had 3 homes at 6 months and mortgage was $1000. It would be doing the following: `getMinimumSavings = 3 (SF) * $1000 (mort) * 6 (months) = $18,000`

totals all properties getExpensesByDate * amount needed to save by month, so properties[].getExpensesByDate() * minMonthsRequired.

Implementation of

ILedgerCollection.getMinimumSavings

---

getMonthlyCashFlowByYear()

getMonthlyCashFlowByYear(year?): number[]

Defined in: ledger/ledger-collection.ts:185

used to get the cashFlow of all 12 months

Parameters

year?

number

Returns

number[]

Implementation of

ILedgerCollection.getMonthlyCashFlowByYear

---

getSummariesAnnual()

getSummariesAnnual(year?): ILedgerDetailSummary[]

Defined in: ledger/ledger-collection.ts:353

Parameters

year?

number

Returns

ILedgerDetailSummary[]

Implementation of

ILedgerCollection.getSummariesAnnual

---

getSummaryAnnual()

getSummaryAnnual(year?): ILedgerDetailSummary

Defined in: ledger/ledger-collection.ts:325

Parameters

year?

number

Returns

ILedgerDetailSummary

Implementation of

ILedgerCollection.getSummaryAnnual

---

getSummaryMonth()

getSummaryMonth(date): ILedgerDetailSummary

Defined in: ledger/ledger-collection.ts:288

Parameters

date

Date

Returns

ILedgerDetailSummary

Implementation of

ILedgerCollection.getSummaryMonth

---

hasMinimumSavings()

hasMinimumSavings(properties, date, minMonthsRequired?): boolean

Defined in: ledger/ledger-collection.ts:177

determines if there is enough money in the account while forcing a hold on the getMinimumSavings amount.

Parameters

properties

IRentalPropertyEntity[]

date

Date

minMonthsRequired?

number = 6

Returns

boolean

Example

hasMinimumSavings = getBalance >= getMinimumSavings

Implementation of

ILedgerCollection.hasMinimumSavings

---

isEmpty()

isEmpty(): boolean

Defined in: ledger/ledger-collection.ts:137

is the collection empty?

Returns

boolean

This site is open source. Improve this page.