realty-investor-timeline

@cubedelement.com/realty-investor-timeline

---

@cubedelement.com/realty-investor-timeline / ledger/ledger-item / LedgerItem

Class: LedgerItem

Defined in: ledger/ledger-item.ts:8

this is an entry into the account. Think of it as a checking account, and it’s simply a transaction line.

Constructors

new LedgerItem()

new LedgerItem(amount?, type?, created?, note?): LedgerItem

Defined in: ledger/ledger-item.ts:14

Parameters

amount?

number

type?

LedgerItemType

created?

Date

note?

string

Returns

LedgerItem

Properties

amount

amount: number = 0

Defined in: ledger/ledger-item.ts:11

---

created?

optional created: Date

Defined in: ledger/ledger-item.ts:10

---

note?

optional note: string

Defined in: ledger/ledger-item.ts:12

---

type

type: LedgerItemType

Defined in: ledger/ledger-item.ts:9

Methods

clone()

clone(): LedgerItem

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

Returns

LedgerItem

---

dateGreaterThanOrEqualTo()

dateGreaterThanOrEqualTo(date): boolean

Defined in: ledger/ledger-item.ts:78

returns true if date’s date is grater than or equal to the created date

Parameters

date

Date

Returns

boolean

---

dateLessThanOrEqualTo()

dateLessThanOrEqualTo(date): boolean

Defined in: ledger/ledger-item.ts:66

returns true if date’s date is less than or equal to the created date

Parameters

date

Date

Returns

boolean

---

dateLessThanOrEqualToAndQuarter()

dateLessThanOrEqualToAndQuarter(date): boolean

Defined in: ledger/ledger-item.ts:106

returns true if date’s date is more recent than or equal to the created date and the quarter matches

Parameters

date

Date

Returns

boolean

---

dateMatchesYear()

dateMatchesYear(year): boolean

Defined in: ledger/ledger-item.ts:94

Parameters

year

number

Returns

boolean

---

dateMatchesYearAndMonth()

dateMatchesYearAndMonth(date): boolean

Defined in: ledger/ledger-item.ts:50

Parameters

date

Date

Returns

boolean

---

dateMatchesYearAndQuarter()

dateMatchesYearAndQuarter(year, quarter): boolean

Defined in: ledger/ledger-item.ts:127

@deprecated, use dateLessThanOrEqualToAndQuarter

Parameters

year

number

quarter

number

Returns

boolean

---

dateNotGreaterThan()

dateNotGreaterThan(date): boolean

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

Parameters

date

Date

Returns

boolean

---

getMonth()

getMonth(): number

Defined in: ledger/ledger-item.ts:27

Returns

number

---

getQuarter()

getQuarter(): -1 | QuarterType

Defined in: ledger/ledger-item.ts:38

if one is found, a zero based quarter number, otherwise you’ll get -1

Returns

-1 | QuarterType

---

getYear()

getYear(): number

Defined in: ledger/ledger-item.ts:143

Returns

number

---

isAmountGreaterThanZero()

isAmountGreaterThanZero(): boolean

Defined in: ledger/ledger-item.ts:46

Returns

boolean

---

typeMatches()

typeMatches(itemType): boolean

Defined in: ledger/ledger-item.ts:139

Parameters

itemType

LedgerItemType

Returns

boolean

This site is open source. Improve this page.