Class TimeoutTransition

A timeout transition is an FSM transition that is not executed by an event: the FSM goes through such a transition on a timeout.

Hierarchy

Constructors

constructor

Properties

action guard logger src tgt timeoutDuration timeoutThread timeouted

Accessors

target

Methods

accept acceptVisitor execute getAcceptedEvents startTimeout stopTimeout uninstall

Constructors

constructor

  • new TimeoutTransition(srcState, tgtState, timeout, logger?, action?): TimeoutTransition

  • Creates the timeout transition.

    Parameters

    • srcState: OutputState

      The source state of the transition.

    • tgtState: InputState

      The output state of the transition.

    • timeout: (() => number)

      The function that returns the timeout value in ms.

        • (): number

        • Returns number

    • Optional logger: Logger

      The logger to use.

    • Optional action: ((evt) => void)

      The action to execute when going through the transition

        • (evt): void

        • Parameters

          • evt: Event

          Returns void

    Returns TimeoutTransition

Properties

Readonly action

action: ((evt) => void)

Type declaration

    • (evt): void

    • Parameters

      • evt: Event

      Returns void

Readonly guard

guard: ((evt) => boolean)

Type declaration

    • (evt): boolean

    • Parameters

      • evt: Event

      Returns boolean

Private Readonly logger

logger: undefined | Logger

Readonly src

src: OutputState

Readonly tgt

tgt: InputState

Private Readonly timeoutDuration

timeoutDuration: (() => number)

Type declaration

    • (): number

    • The timeoutDuration in ms.

      Returns number

Private timeoutThread

timeoutThread: undefined | number

The current thread in progress.

Private timeouted

timeouted: boolean

Accessors

target

Methods

accept

acceptVisitor

execute

getAcceptedEvents

  • getAcceptedEvents(): ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">

  • Returns ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">

    The set of events accepted by the transition.

startTimeout

stopTimeout

uninstall

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc