From 17ae81f04074ad5b2fdbb21f221e33e69b425e53 Mon Sep 17 00:00:00 2001
From: jsteuer <jan.steuer.htw@gmail.com>
Date: Wed, 05 Feb 2020 11:36:17 +0100
Subject: [PATCH] better docs, ide-tool-utils as ts, es6 and es5
---
src/MathCoach.ts | 37 +++++++++++++++++++++++++------------
1 files changed, 25 insertions(+), 12 deletions(-)
diff --git a/mathcoach-api.d.ts b/src/MathCoach.ts
similarity index 89%
rename from mathcoach-api.d.ts
rename to src/MathCoach.ts
index bb80ace..cb2f5ee 100644
--- a/mathcoach-api.d.ts
+++ b/src/MathCoach.ts
@@ -1,9 +1,13 @@
-/**
- * Wenn die Bibliothek zur Erweiterung der IDE eingebunden (`ide-lib.js`) wurde,
- * steht diese globale Variable mit Zugang zur öffentlichen Schnittstelle
- * zur Verfügung.
- */
-declare const MC: MathCoach.Api;
+declare global {
+ /**
+ * Wenn die Bibliothek zur Erweiterung der IDE eingebunden (`ide-lib.js`) wurde,
+ * steht diese globale Variable mit Zugang zur öffentlichen Schnittstelle
+ * zur Verfügung.
+ */
+ const MC: MathCoach.Api;
+}
+
+
/**
* Der MathCoach-Namensraum ist die Sammelstelle für alle öffentlichen Schnittstellen.
@@ -12,15 +16,24 @@
* 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
*/
-declare namespace MathCoach {
+export namespace MathCoach {
/**
* 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
*/
- interface Api {
+ export interface Api {
/**
* Die Schnittstelle zur Entwicklungsumgebung (IDE) von MathCoach.
*/
@@ -55,7 +68,7 @@
/**
* Schnittstelle zur IDE von MathCoach
*/
- interface IdeApi {
+ export interface IdeApi {
/**
* Gibt den Namen des aktuellen Benutzers zurück, der mit dem Werkzeug arbeitet.
*
@@ -86,7 +99,7 @@
/**
* Schnittstelle zur Navigation der Vorschau
*/
- interface NavigatorApi {
+ export interface NavigatorApi {
/**
* Navigiert die Vorschau zu einem Link.
*
@@ -117,7 +130,7 @@
/**
* Schnittstelle zum Dateisystem
*/
- interface FileSystemApi {
+ export interface FileSystemApi {
/**
* Liest eine Datei und gibt den Textinhalt zurück.
*
@@ -155,7 +168,7 @@
* Siehe auch: `MC.ide.getContextFile()`
*
*/
- interface File {
+ export interface File {
/**
* Name des Besitzers. Hinweis: Der Besitzter kann vom angemeldeten
* Benutzer abweichen (z.B. wenn das Teilen von Inhalten zukünftig unterstützt wird)
--
Gitblit v1.10.0-SNAPSHOT