Search
Preparing search index...
The search index is not available
Retirement Simulator - v0.1.14
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Retirement Simulator - v0.1.14
model/income-stream
IncomeStreamState
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
[to
String
Tag]
categories
end
id
item
name
notes
pretty
Name
scenario
scenarios
sort
spec
start
state
temporal
type
value
Methods
has
Category
in
Scenario
states
withdraw
Constructors
constructor
new
Income
Stream
State
(
row
:
ItemImpl
<
"incomeStream"
>
, scenario
:
IFScenario
, state
:
IItemState
<
"incomeStream"
>
)
:
IncomeStreamState
Parameters
row:
ItemImpl
<
"incomeStream"
>
scenario:
IFScenario
state:
IItemState
<
"incomeStream"
>
Returns
IncomeStreamState
Properties
[to
String
Tag]
[to
String
Tag]
:
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
pretty
Name
pretty
Name
:
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
has
Category
has
Category
(
category
:
Category
)
:
boolean
Parameters
category:
Category
Returns
boolean
in
Scenario
in
Scenario
(
scenario
:
string
)
:
boolean
Parameters
scenario:
string
Returns
boolean
states
states
(
start
:
CalendarStep
)
:
Generator
<
IItemState
<
"incomeStream"
>
,
any
,
IItemState
<
"incomeStream"
>
>
Parameters
start:
CalendarStep
Returns
Generator
<
IItemState
<
"incomeStream"
>
,
any
,
IItemState
<
"incomeStream"
>
>
withdraw
withdraw
(
value
:
Money
, purpose
:
string
, states
:
ItemStates
)
:
Money
Parameters
value:
Money
purpose:
string
states:
ItemStates
Returns
Money
Modules
model/income-
stream
Income
Stream
Income
Stream
State
constructor
[to
String
Tag]
categories
end
id
item
name
notes
pretty
Name
scenario
scenarios
sort
spec
start
state
temporal
type
value
has
Category
in
Scenario
states
withdraw
as
Income
Stream
is
Income
Stream
to
Income
Stream
Generated using
TypeDoc