Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKernelUser<T>

Interface for a Kernel user to register itself with the IKernelMenu's semantic extension points.

Type parameters

  • T: Widget

Hierarchy

Index

Properties

Properties

Optional changeKernel

changeKernel: (widget: T) => Promise<void>

Type declaration

    • (widget: T): Promise<void>

    • A function to change the kernel.

      Parameters

      • widget: T

      Returns Promise<void>

Optional interruptKernel

interruptKernel: (widget: T) => Promise<void>

Type declaration

    • (widget: T): Promise<void>

    • A function to interrupt the kernel.

      Parameters

      • widget: T

      Returns Promise<void>

Optional isEnabled

isEnabled: (widget: T) => boolean

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

    • 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)

      Parameters

      • widget: T

      Returns boolean

Optional reconnectToKernel

reconnectToKernel: (widget: T) => Promise<void>

Type declaration

    • (widget: T): Promise<void>

    • A function to reconnect to the kernel

      Parameters

      • widget: T

      Returns Promise<void>

Optional restartKernel

restartKernel: (widget: T) => Promise<boolean>

Type declaration

    • (widget: T): Promise<boolean>

    • A function to restart the kernel, which returns a promise of whether the kernel was restarted.

      Parameters

      • widget: T

      Returns Promise<boolean>

Optional restartKernelAndClear

restartKernelAndClear: (widget: T) => Promise<boolean>

Type declaration

    • (widget: T): Promise<boolean>

    • A function to restart the kernel and clear the widget, which returns a promise of whether the kernel was restarted.

      Parameters

      • widget: T

      Returns Promise<boolean>

Optional restartKernelAndClearLabel

restartKernelAndClearLabel: (n: number) => string

Type declaration

    • (n: number): string

    • A function to return the label associated to the restartKernelAndClear action.

      This function receives the number of items n to be able to provided correct pluralized forms of translations.

      Parameters

      • n: number

      Returns string

Optional shutdownKernel

shutdownKernel: (widget: T) => Promise<void>

Type declaration

    • (widget: T): Promise<void>

    • A function to shut down the kernel.

      Parameters

      • widget: T

      Returns Promise<void>

tracker

tracker: IWidgetTracker<T>

A widget tracker for identifying the appropriate extender.

Generated using TypeDoc