Interface FinancialObservation<D>

An actual or target observation. Observations should include either a value (for financial metrics) or measure (for other metrics).

Type parameters

  • <D>: Dimensions = undefined

    Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

Constructors

Properties

Methods

Constructors

constructor

Properties

dimensions Optional

: D

Any number of dimensions can be recorded within this object. Dimensions names should follow the camelCase conventions of OCDS.

id

: string

A local identifier for this specific observation. This may be an arbitrary identifier, or could be a composite of the metric identifier, and the date and other dimensions of this observation.

notes Optional

: undefined | string

Any notes on this observation. This may include clarifying information.

period Optional

: Period

The period over which this observation is measured.

relatedImplementationMilestone Optional

: MilestoneReference

A link to the milestone in the implementation section of OCDS to which this forecast, target or actual observation relates.

unit Optional

: Unit

Unit.Unit.

value

: Value

The value of this forecast, target or actual observation.

Methods

isFinancial

  • (): this is FinancialObservation<D>

isNonFinancial

  • (): this is NonFinancialObservation<D>

Generated using TypeDoc. Made by uStudio Company with ❤️