Class CashFlow<T>

An expense or income; that is, money flowing in or out.

Type parameters

T: CashFlowType

Hierarchy

Monetary<T>
- CashFlow
  - Expense
  - IncomeStream
  - IncomeTax
  - Income

Implements

ICashFlowItem<T>

Index

Constructors

constructor

Properties

Accessors

temporal

Methods

Constructors

constructor

new CashFlow<T>(row: RowType<T>, scenario: IFScenario): CashFlow<T>

Overrides Monetary.constructor
- Defined in src/model/cashflow.ts:18
Type parameters
- T: CashFlowType
Parameters
- row: RowType<T>
- scenario: IFScenario
Returns CashFlow<T>

Properties

Private Optional #temporal

#temporal: Temporal<CashFlow<T>> = ...

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

Readonly value

value: Money

Accessors

temporal

get temporal(): Temporal<this>
set temporal(value: Temporal<this>): void

Implementation of ICashFlowItem.temporal
- Defined in src/model/item.ts:58
Returns Temporal<this>
Implementation of ICashFlowItem.temporal
- Defined in src/model/item.ts:53
Parameters
- value: Temporal<this>
Returns void

Methods

hasCategory

hasCategory(category: Category): boolean

Inherited from Monetary.hasCategory
- Defined in src/model/item.ts:90
Determine if an item is in a specified category.

Parameters
- category: Category
Returns boolean

inScenario

inScenario(scenario: string): boolean

Inherited from Monetary.inScenario
- Defined in src/model/item.ts:97
Determine if an item is in a specified scenario.

Parameters
- scenario: string
Returns boolean

states

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

Inherited from Monetary.states
- Defined in src/model/item.ts:62
Parameters
- start: CalendarStep
Returns Generator<IItemState<"scenario" | "incomeStream" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "person" | "text">, any, IItemState<"scenario" | "incomeStream" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "person" | "text">>

Generated using TypeDoc