Class IncomeStreamState

Hierarchy

IIncomeStream<this> & { type: "incomeStream" } & ItemMethods<"incomeStream", this> & { withdraw: any } & { id: string; prettyName: string; scenario: ItemImpl<"scenario">; temporal: Temporal<ItemImpl<"incomeStream">> } & IState<"incomeStream", this> & { [toStringTag]: string }
- IncomeStreamState

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IncomeStreamState(row: ItemImpl<"incomeStream">, scenario: IFScenario, state: IItemState<"incomeStream">): IncomeStreamState

Overrides StateMixin(IncomeStream).constructor
- Defined in src/model/income-stream.ts:134
Parameters
- row: ItemImpl<"incomeStream">
- scenario: IFScenario
- state: IItemState<"incomeStream">
Returns IncomeStreamState

Properties

[toStringTag]

[toStringTag]: string

categories

categories: Category[]

Optional Readonly end

end: boolean

id

id: string

Readonly item

item: RowType<"incomeStream">

Readonly name

name: string

Optional notes

notes: string

prettyName

prettyName: string

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 spec

spec: IncomeStreamSpec

Readonly start

start: Date

Readonly state

state: IItemState<"incomeStream">

temporal

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

Readonly type

type: "incomeStream"

Readonly value

value: Money

Methods

hasCategory

hasCategory(category: Category): boolean

Inherited from StateMixin(IncomeStream).hasCategory
- Defined in src/types.ts:52
Parameters
- category: Category
Returns boolean

inScenario

inScenario(scenario: string): boolean

Inherited from StateMixin(IncomeStream).inScenario
- Defined in src/types.ts:53
Parameters
- scenario: string
Returns boolean

states

states(start: CalendarStep): Generator<IItemState<"incomeStream">, any, IItemState<"incomeStream">>

Inherited from StateMixin(IncomeStream).states
- Defined in src/types.ts:54
Parameters
- start: CalendarStep
Returns Generator<IItemState<"incomeStream">, any, IItemState<"incomeStream">>

withdraw

withdraw(value: Money, purpose: string, states: ItemStates): Money

Inherited from StateMixin(IncomeStream).withdraw
- Defined in src/types.ts:62
Parameters
- value: Money
- purpose: string
- states: ItemStates
Returns Money

Generated using TypeDoc