Class Sim

Hierarchy

Sim

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Sim(scenario: Scenario, start?: Date, end?: Date): Sim

- Defined in src/sim/sim.ts:78
Parameters
- scenario: Scenario
- Optional start: Date
- Optional end: Date
Returns Sim

Properties

Private #context

#context: SimContext

Private Optional #snapshots

#snapshots?: Snapshot[]

Private Optional #timelineArray

#timelineArray?: TimeLineItem<TimeLineAction>[]

end

end: Date

prerollStart

prerollStart: Date

scenario

scenario: Scenario

start

start: Date

Optional states

states?: ItemStates

Accessors

snapshots

get snapshots(): Snapshot[]

- Defined in src/sim/sim.ts:88
Returns Snapshot[]

timeline

get timeline(): TimeLineItem<TimeLineAction>[]

- Defined in src/sim/sim.ts:96
Get the full timeline in sorted order as an array.

Returns TimeLineItem<TimeLineAction>[]

Methods

Private #runSim

#runSim(): Snapshot[]

- Defined in src/sim/sim.ts:253
Returns Snapshot[]

addTimeLine

addTimeLine<A>(action: A, date: Date, item: ActionItem<A>, data: ActionData<A>): void

- Defined in src/sim/sim.ts:106
Type parameters
- A: TimeLineAction
Parameters
- action: A
- date: Date
- item: ActionItem<A>
- data: ActionData<A>
Returns void

copyStates

copyStates(states: ItemStates): ItemStates

- Defined in src/sim/sim.ts:249
Parameters
- states: ItemStates
Returns ItemStates

initStates

initStates(init: CalendarStep): ItemStates

- Defined in src/sim/sim.ts:111
Parameters
- init: CalendarStep
Returns ItemStates

payExpenses

payExpenses(period: CalendarStep): void

- Defined in src/sim/sim.ts:138
Parameters
- period: CalendarStep
Returns void

stepItemState

stepItemState<T>(itemState: StateItem<T>, step: CalendarStep): null | StateItem<T>

- Defined in src/sim/sim.ts:162
Type parameters
- T: "asset" | "liability" | "income" | "expense" | "incomeStream" | "incomeTax" | "person" | "text" | "scenario"
Parameters
- itemState: StateItem<T>
- step: CalendarStep
Returns null | StateItem<T>

Generated using TypeDoc