Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiabilityState

Hierarchy

  • ILiability<this> & { type: "liability" } & ItemMethods<"liability", this> & { id: string; prettyName: string; scenario: ItemImpl<"scenario">; temporal: Temporal<ItemImpl<"liability">> } & IState<"liability", this> & { [toStringTag]: string }
    • LiabilityState

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

[toStringTag]

[toStringTag]: string

categories

categories: Category[]

Optional Readonly end

end: boolean

Optional Readonly expense

expense: string

id

id: string

Readonly item

item: RowType<"liability">

Readonly name

name: string

Optional notes

notes: string

Optional Readonly payment

payment: Money

Readonly paymentPeriod

paymentPeriod: CalendarUnit

Payment frequency

prettyName

prettyName: string

Readonly rate

rate: Rate

Interest rate, per payment period. Will need to canonicalize compounding periods (APR vs simple, etc.) Non interest-bearing assets, or loans use a value of 1.0,;

Readonly rateType

rateType: string

Type of interest rate calculation, or the name of a time series calculator.

Readonly scenario

scenario: IScenario & { type: "scenario" } & ItemMethods<"scenario"> & { asset_list: IFAsset[]; assets: NamedIndex<IFAsset>; expense_list: IFExpense[]; expenses: NamedIndex<IFExpense>; incomeStream_list: IFIncomeStream[]; incomeStreams: NamedIndex<IFIncomeStream>; income_list: IFIncome[]; incomes: NamedIndex<IFIncome>; liabilities: NamedIndex<IFLiability>; liability_list: IFLiability[]; people: NamedIndex<IFPerson>; person_list: IFPerson[]; scenario: IFScenario; spouse1: IFPerson; spouse2: null | IFPerson; tax_list: IFIncomeTax[]; taxes: NamedIndex<IFIncomeTax>; text_list: IFText[]; texts: NamedIndex<IFText> } & { findItem: any; findItems: any; findText: any } & { id: string; prettyName: string; scenario: ItemImpl<"scenario">; temporal: Temporal<ItemImpl<"scenario">> }

scenarios

scenarios: string[]

sort

sort: number

Readonly start

start: Date

Readonly state

state: IItemState<"liability"> & { interest: Money; payment: Money; principal: Money; rate: Rate; value: Money }

temporal

temporal: Temporal<TemporalItem<"liability">> & Temporal<ItemImpl<"liability">>

Readonly type

type: "liability"

Readonly value

value: Money

Methods

hasCategory

  • hasCategory(category: Category): boolean

  • Parameters

    Returns boolean

inScenario

  • inScenario(scenario: string): boolean

  • Parameters

    • scenario: string

    Returns boolean

states

Generated using TypeDoc