Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICodeRunner<T>

An object that runs code, which may be registered with the Run menu.

Type parameters

  • T: Widget

Hierarchy

Index

Properties

Optional isEnabled

isEnabled: function

An additional function that determines whether the extender is enabled. By default it is considered enabled if the application active widget is contained in the tracker. If this is also provided, the criterion is equivalent to tracker.has(widget) && extender.isEnabled(widget)

Type declaration

    • (widget: T): boolean
    • Parameters

      • widget: T

      Returns boolean

noun

noun: string

A string label for the thing that is being run, which is used to populate the menu labels.

Optional restartAndRunAll

restartAndRunAll: function

A function to restart and run all the code hosted by the widget, which returns a promise of whether the action was performed.

Type declaration

    • (widget: T): Promise<boolean>
    • Parameters

      • widget: T

      Returns Promise<boolean>

Optional run

run: function

A function to run a chunk of code.

Type declaration

    • (widget: T): Promise<void>
    • Parameters

      • widget: T

      Returns Promise<void>

Optional runAll

runAll: function

A function to run the entirety of the code hosted by the widget.

Type declaration

    • (widget: T): Promise<void>
    • Parameters

      • widget: T

      Returns Promise<void>

tracker

tracker: IWidgetTracker<T>

A widget tracker for identifying the appropriate extender.

Generated using TypeDoc