Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CalculatingMessage

A message sent when options are evaluating.

Notes

The messages contain state info about what options are being evaluated, or have finished evaluating.

Hierarchy

  • Message
    • CalculatingMessage

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new CalculatingMessage(type: "before-option-calc" | "after-option-calc", options: Set<string>): CalculatingMessage

  • Parameters

    • type: "before-option-calc" | "after-option-calc"
    • options: Set<string>

    Returns CalculatingMessage

Properties

options

options: Set<string>

type

type: string

The type of the message.

Notes

The type of a message should be related directly to its actual runtime type. This means that type can and will be used to cast the message to the relevant derived Message subtype.

Accessors

isConflatable

  • get isConflatable(): boolean

  • Returns boolean

Methods

conflate

  • conflate(other: Message): boolean

  • Conflate this message with another OptionEvalMessage

    Notes

    User code should not call this function!

    This means that any Option Eval Messages delivered synchronously within the same loop will be conflated with one another- that is, their state will be merged and only a single message will be delivered to the widget.

    Parameters

    • other: Message

    Returns boolean

Static IsCalcMsg

  • IsCalcMsg(msg: Message): msg is CalculatingMessage

  • Parameters

    • msg: Message

    Returns msg is CalculatingMessage

Generated using TypeDoc