Search
Preparing search index...
The search index is not available
Retirement Simulator - v0.2.0
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Retirement Simulator - v0.2.0
IncomeState
Class IncomeState
Hierarchy
IIncome
<
this
>
&
ItemMethods
<
"income"
,
this
>
&
TemporalItemImpl
<
"income"
,
this
>
&
{
id
:
`
income/
${
string
}
`
;
prettyName
:
string
;
scenario
:
ItemImpl
<
"scenario"
>
}
&
IState
<
"income"
,
this
>
&
{
[toStringTag]
:
string
}
IncomeState
Index
Constructors
constructor
Properties
[to
String
Tag]
categories
end
id
item
name
notes
payment
Period
pretty
Name
scenario
scenarios
sort
start
state
temporal
type
value
Methods
has
Category
in
Scenario
stepper
Constructors
constructor
new
Income
State
(
row
:
ItemImpl
<
"income"
>
, scenario
:
IFScenario
, state
:
ItemState
<
"income"
>
)
:
IncomeState
Parameters
row:
ItemImpl
<
"income"
>
scenario:
IFScenario
state:
ItemState
<
"income"
>
Returns
IncomeState
Properties
[to
String
Tag]
[to
String
Tag]
:
string
categories
categories
:
Category
[]
Optional
Readonly
end
end
?:
boolean
id
id
:
`
income/
${
string
}
`
Readonly
item
item
:
IIncome
Readonly
name
name
:
string
Optional
notes
notes
?:
string
Readonly
payment
Period
payment
Period
:
CalendarUnit
Payment frequency
pretty
Name
pretty
Name
:
string
scenario
scenario
:
IScenario
&
ItemMethods
<
"scenario"
>
&
{
asset_list
:
IFAsset
[]
;
assets
:
NamedIndex
<
IFAsset
>
;
byId
:
{}
;
dateRange
:
[
start
:
Date
,
end
:
Date
]
;
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
}
&
TemporalItemImpl
<
"scenario"
>
&
{
id
:
`
scenario/
${
string
}
`
;
prettyName
:
string
;
scenario
:
ItemImpl
<
"scenario"
>
}
scenarios
scenarios
:
string
[]
sort
sort
:
number
Readonly
start
start
:
Date
Readonly
state
state
:
ItemState
<
"income"
>
temporal
temporal
:
Temporal
<
ItemImpl
<
"income"
>
>
Readonly
type
type
:
"income"
Readonly
value
value
:
Money
Methods
has
Category
has
Category
(
category
:
Category
)
:
boolean
Parameters
category:
Category
Returns
boolean
in
Scenario
in
Scenario
(
scenario
:
string
)
:
boolean
Parameters
scenario:
string
Returns
boolean
stepper
stepper
(
step
:
CalendarStep
, ctx
:
SimContext
)
:
Stepper
<
"income"
>
Parameters
step:
CalendarStep
ctx:
SimContext
Returns
Stepper
<
"income"
>
Exports
Internals
Externals
G
Income
State
constructor
[to
String
Tag]
categories
end
id
item
name
notes
payment
Period
pretty
Name
scenario
scenarios
sort
start
state
temporal
type
value
has
Category
in
Scenario
stepper
Generated using
TypeDoc
Payment frequency