Interface Api

Als Einstiegspunkt dient das interface MathCoach.Api - eine Implementierung dieser Schnittstelle wird von der IDE (siehe ide-lib.js) bereitgestellt und kann über die globale Variable MC zugegriffen werden.

Beispiel:

const isReady = await MC.ide.isReady(); // true oder false

Hierarchy

  • Api

Properties

ide

Methods

isReady

Properties

Readonly ide

ide: IdeApi

Die Schnittstelle zur Entwicklungsumgebung (IDE) von MathCoach.

Methods

isReady

  • Prüft, ob die API einsatzbereit ist. Dies sollte einmalig, beim Start des Werkzeugs, geprüft werden. Dabei bedeutet der Rückgabewert true, dass das Werkzeug durch die IDE gestartet wurde und die Kommunikation möglich ist. false bedeutet, dass das Werkzeug nicht durch die IDE gestartet wurde.

    Somit wäre es möglich ein Tool offlinefähig zu machen, indem es ggf. eine eigene Implementierung der MathCoach-API (beispielsweise unter Verwendung des LocalStorage zum Speichern von Dateien) verwendet.

    Anwendungsbeispiel (Prüft zusätzlich, ob die globale MC-Variable verfügbar ist - also die ide-lib.js korrekt eingebunden und geladen wurde):

     let isReady = (typeof MC !== "undefined") ? await MC.isReady() : false;
     if(isReady){
         // MathCoach-API is ready to use!
     }else{
         // MathCoach-API is not ready...
     }

    Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc