Class Income

An income item. By default, annual, but can be constrained to a particular period of time.

Key fields:

value

Hierarchy

CashFlow<"income">
- Income

Implements

IIncome

Index

Constructors

constructor

Properties

Accessors

temporal

Methods

Constructors

constructor

new Income(row: RowType<"income">, scenario: IFScenario): Income

Overrides CashFlow.constructor
- Defined in src/model/income.ts:22
Parameters
- row: RowType<"income">
- scenario: IFScenario
Returns Income

Properties

Private Optional #temporal

#temporal: Temporal<Income> = ...

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: "income"

Readonly value

value: Money

Accessors

temporal

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

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

Methods

hasCategory

hasCategory(category: Category): boolean

Inherited from CashFlow.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 CashFlow.inScenario
- Defined in src/model/item.ts:97
Determine if an item is in a specified scenario.

Parameters
- scenario: string
Returns boolean

states

states<T>(start: CalendarStep): Generator<IItemState<"income"> & { value: Money }, any, IItemState<"income"> & { value: Money }>

Overrides CashFlow.states
- Defined in src/model/income.ts:26
Type parameters
- T: "incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text"
Parameters
- start: CalendarStep
Returns Generator<IItemState<"income"> & { value: Money }, any, IItemState<"income"> & { value: Money }>

Static inScenario

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

Inherited from CashFlow.inScenario
- Defined in src/model/item.ts:101
Parameters
- scenario: string
- scenarios: string[] | IItem<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">
Returns boolean

Generated using TypeDoc