Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Asset

An item with a monetary value. If growth is supplied and not equal to 1.0, the asset value will change by that factor each period (currently, always annually, pro-rated).

Key fields:

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional #temporal

#temporal: Temporal<Asset> = ...

Readonly categories

categories: Category[]

Optional Readonly end

end: boolean

Readonly id

id: string

Readonly name

name: string

Optional notes

notes: string

paymentPeriod

paymentPeriod: CalendarUnit

Payment frequency

prettyName

prettyName: string

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,;

rateType

rateType: string

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

Readonly scenario

scenario: IFScenario

Readonly scenarios

scenarios: string[]

sort

sort: number

Sort order

Readonly start

start: Date

Readonly type

type: "asset"

Readonly value

value: Money

Accessors

temporal

Methods

hasCategory

  • hasCategory(category: Category): boolean

inScenario

  • inScenario(scenario: string): boolean

  • Determine if an item is in a specified scenario.

    Parameters

    • scenario: string

    Returns boolean

states

Static inScenario

  • inScenario(scenario: string, scenarios: string[] | IItem<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">): boolean

  • Parameters

    • scenario: string
    • scenarios: string[] | IItem<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">

    Returns boolean

Generated using TypeDoc