Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncomeStream

A composite stream of money used to pay expenses (or potentially, to contribute to assets, NYI).

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional #boundSpec

#boundSpec: IncomeStreamBoundSpec

Private #rawSpec

#rawSpec: IncomeStreamSpec

Private Optional #temporal

#temporal: Temporal<IncomeStream> = ...

Readonly categories

categories: Category[]

Optional Readonly end

end: boolean

fraction

fraction: Rate

Readonly id

id: string

Readonly name

name: string

Optional notes

notes: string

prettyName

prettyName: string

Readonly scenario

scenario: IFScenario

Readonly scenarios

scenarios: string[]

sort

sort: number

Sort order

Readonly start

start: Date

Readonly type

type: "incomeStream"

Readonly value

value: Money

Accessors

temporal

Methods

hasCategory

  • hasCategory(category: Category): boolean

inScenario

  • inScenario(scenario: string): boolean

states

  • states(start: CalendarStep): Generator<IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">, any, IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">>

  • Parameters

    Returns Generator<IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">, any, IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">>

withdraw

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