Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PersonState

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

[toStringTag]

[toStringTag]: string

Readonly birth

birth: Date

For actuarial and Social Security calculation purposes.

categories

categories: Category[]

Optional Readonly end

end?: boolean

id

id: `person/${string}`

Readonly item

item: IPerson

Readonly name

name: string

Optional notes

notes?: string

prettyName

prettyName: 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[]

sex

sex: Sex

For actuarial purposes.

sort

sort: number

Readonly start

start: Date

Readonly state

state: ItemState<"person">

Readonly survivalProbabilities

survivalProbabilities: Probability[]

temporal

temporal: Temporal<ItemImpl<"person">>

Readonly type

type: "person"

Methods

age

  • Get the fractional age on the date of interest.

    Parameters

    • date: Date

      the date of interest.

    Returns Age

  • Obtain the integer age reached on the birthday occurring in the specified year.

    Parameters

    • year: Year

      Year as an integer

    Returns Age

hasCategory

  • hasCategory(category: Category): boolean

inScenario

  • inScenario(scenario: string): boolean

  • Parameters

    • scenario: string

    Returns boolean

stepper

Generated using TypeDoc