Class Reaction<T>

constructor

• new Reaction<T>(reactor, sandbox, trigs, args, react, deadline?, late?): Reaction<T>

• Construct a new reaction by passing in a reference to the reactor that will own it, an object to execute the its react and late functions on, a list of triggers, the arguments to pass into react and late, an implementation of this reaction's react function, an optional deadline to be observed, and an optional custom implementation of the late function that is invoked when logical time lags behind physical time with a margin that exceeds the time interval denoted by the deadline.

  Type Parameters

  • T extends Variable[]

  Parameters

  • reactor: Reactor

    The owner of this reaction.
  • sandbox: ReactionSandbox

    The this object for react and late.
  • trigs: Variable[]

    The ports, actions, or timers, which, when they receive values, will trigger this reaction.
  • args: [...ArgList<T>[]]

    The arguments to be passed to react and late.
  • react: ((...args: ArgList<T>) => void)

    Function that gets execute when triggered and "on time."

    • • (...args): void

      • Parameters

        • Rest...args: ArgList<T>

        Returns void

  • Optionaldeadline: TimeValue

    The maximum amount by which logical time may lag behind physical time when react has been triggered and is ready to execute.
  • late: ((...args: ArgList<T>) => void) = ...

    Function that gets execute when triggered and "late."

    • • (...args): void

      • Parameters

        • Rest...args: ArgList<T>

        Returns void

  Returns Reaction<T>

active

Readonlyargs

next

Readonlytrigs

doReact

• doReact(): void

• Invoke the react function in the appropriate sandbox and with the argument list that was specified upon the construction of this reaction object.

  Returns void

getPriority

• getPriority(): number

• Return the priority of this reaction. It determines the execution order among reactions staged for execution at the same logical time.

  Returns number

hasPriorityOver

• hasPriorityOver(another): boolean

• Return whether or not this reaction has priority over another.

  Parameters

  • another: undefined | PrioritySetElement<number>

    Reaction to compare this reaction's priority against.

  Returns boolean

isTriggeredImmediately

• isTriggeredImmediately(): boolean

• Return true if this reaction is triggered immediately (by startup or a timer with zero offset).

  Returns boolean

setDeadline

• setDeadline(deadline): this

• Set a deadline for this reaction. The given time value denotes the maximum allowable amount by which logical time may lag behind physical time at the point that this reaction is ready to execute. If this maximum lag is exceeded, the late function is executed instead of the react function.

  Parameters

  • deadline: TimeValue

    The deadline to set to this reaction.

  Returns this

setPriority

• setPriority(priority): void

• Set for reaction priority, to be used only by the runtime environment. The priority of each reaction is determined on the basis of its dependencies on other reactions.

  Parameters

  • priority: number

    The priority for this reaction.

  Returns void

toString

• toString(): string

• Return string representation of the reaction.

  Returns string

updateIfDuplicateOf

• updateIfDuplicateOf(node): boolean

• Return whether another, newly staged reaction is equal to this one. Because reactions are just object references, no updating is necessary. Returning true just signals that the scheduler shouldn't stage it twice.

  Parameters

  • node: undefined | PrioritySetElement<number>

  Returns boolean