Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Item<T>

Base class for all items. Holds all the common fields.

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Type parameters

    • T: "incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text"

    Parameters

    Returns Item<T>

Properties

Private Optional #temporal

#temporal: Temporal<Item<T>> = ...

Readonly categories

categories: Category[]

Optional Readonly end

end: boolean

Readonly id

id: string

Readonly name

name: string

Optional notes

notes: string

prettyName

prettyName: string

Readonly scenario

scenario: IFScenario

Readonly scenarios

scenarios: string[]

sort

sort: number

Sort order

Readonly start

start: Date

Readonly type

type: T

Accessors

temporal

Methods

hasCategory

  • hasCategory(category: Category): boolean

inScenario

  • inScenario(scenario: string): boolean

  • Determine if an item is in a specified scenario.

    Parameters

    • scenario: string

    Returns boolean

states

  • states(start: CalendarStep): Generator<IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">, any, IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">>

  • Parameters

    Returns Generator<IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">, any, IItemState<"incomeStream" | "person" | "scenario" | "asset" | "liability" | "income" | "expense" | "incomeTax" | "text">>

Static inScenario

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

  • Parameters

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

    Returns boolean

Generated using TypeDoc