Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Person

A person (typically a spouse or domestic partner). Birth date and sex must be specified for correct actuarial data.

Key fields:

Hierarchy

  • Item<"person">
    • Person

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional #survivalProbabilities

#survivalProbabilities?: Probability[]

Private Optional #temporal

#temporal?: Temporal<ItemImpl<"person">> = undefined

birth

birth: Date

Readonly categories

categories: Category[]

Optional Readonly end

end?: boolean

expectencies

expectencies: number[]

expectency

expectency: number

Readonly id

id: `person/${string}`

Readonly name

name: string

Optional notes

notes?: string

prettyName

prettyName: string

Readonly scenario

scenario: IFScenario

Readonly scenarios

scenarios: string[]

sex

sex: Sex

sort

sort: number

Sort order

Readonly start

start: Date

Readonly type

type: "person"

Accessors

survivalProbabilities

  • An array of the probabilities of dying in the nth subsequent year.

    Returns Probability[]

temporal

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

iage

  • Obtain the integer age on a specified date. This is used for things like tax computation where the age is treated as a year-based threshold or as a table index.

    Parameters

    • date: Date

      Date of interest

    Returns IAge

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

    Parameters

    • year: Year

      Year as an integer

    Returns IAge

inScenario

  • inScenario(scenario: string): boolean

  • Determine if an item is in a specified scenario.

    Parameters

    • scenario: string

    Returns boolean

stepper

Static inScenario

  • inScenario(scenario: string, scenarios: string[] | IItem<"asset" | "liability" | "income" | "expense" | "incomeStream" | "incomeTax" | "person" | "text" | "scenario">): boolean

  • Parameters

    • scenario: string
    • scenarios: string[] | IItem<"asset" | "liability" | "income" | "expense" | "incomeStream" | "incomeTax" | "person" | "text" | "scenario">

    Returns boolean

Generated using TypeDoc