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:82

Implements

• ILedgerCollection

Constructors

new LedgerCollection()

new LedgerCollection(): LedgerCollection

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

Returns

LedgerCollection

Methods

add()

add(item): void

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

Parameters

item

LedgerItem

Iterable<LedgerItem>

Returns

void

Implementation of

ILedgerCollection.add

---

clone()

clone(): ILedgerCollection

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

Returns

ILedgerCollection

Implementation of

ILedgerCollection.clone

---

filter()

filter(pred?): LedgerItem[]

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

Parameters

pred?

LedgerItemPredicate

Returns

LedgerItem[]

Implementation of

ILedgerCollection.filter

---

getAvailableSavings()

getAvailableSavings(date, properties, minMonthsRequired): number

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

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:176

Parameters

collection

LedgerItem[]

type

LedgerItemType

Returns

number

---

getBalance()

getBalance(date?): number

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

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:215

Parameters

date?

Date

Returns

number

Implementation of

ILedgerCollection.getCashFlowMonth

---

getCashFlowMonthCollection()

getCashFlowMonthCollection(year?): number[]

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

used to get the cashFlow of all 12 months

Parameters

year?

number

Returns

number[]

Implementation of

ILedgerCollection.getCashFlowMonthCollection

---

getCashFlowYearAverage()

getCashFlowYearAverage(date?): number

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

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:358

Returns

LedgerItem[]

Implementation of

ILedgerCollection.getLastLedgerMonth

---

getLatestLedgerItem()

getLatestLedgerItem(): LedgerItem

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

Returns

LedgerItem

Implementation of

ILedgerCollection.getLatestLedgerItem

---

getMinimumSavings()

getMinimumSavings(properties, date, minMonthsRequired): number

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

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

---

getSummariesAnnual()

getSummariesAnnual(year?): ILedgerSummary[]

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

Parameters

year?

number

Returns

ILedgerSummary[]

Implementation of

ILedgerCollection.getSummariesAnnual

---

getSummaryAnnual()

getSummaryAnnual(year?): ILedgerSummary

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

Parameters

year?

number

Returns

ILedgerSummary

Implementation of

ILedgerCollection.getSummaryAnnual

---

getSummaryMonth()

getSummaryMonth(date): ILedgerSummary

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

Parameters

date

Date

Returns

ILedgerSummary

Implementation of

ILedgerCollection.getSummaryMonth

---

hasMinimumSavings()

hasMinimumSavings(properties, date, minMonthsRequired): boolean

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

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:132

is the collection empty?

Returns

boolean

This site is open source. Improve this page.