diff --git a/help/documentation.md b/help/documentation.md index d22d6b7..5aa7d80 100644 --- a/help/documentation.md +++ b/help/documentation.md @@ -6,28 +6,32 @@ ##Overlays -[Erstelle ein element mit in html und vergebe eine id. Um das overlay anzuzeigen, rufe showOverlay mit der id auf] +``` +//Erstelle ein element mit in html und vergebe eine id. Um das overlay anzuzeigen, rufe showOverlay mit der id auf function showOverlay(string id); -[Schließe das overlay mit der id] +//Schließe das overlay mit der id function hideOverlay(string id); +``` ##CouchDB +``` //Klasse zum Interagieren mit CouchDB //Erstelle eine neue CouchDB-Klasse mit new CouchDB(); class CouchDB { - [Überprüfe, ob CouchDB online ist. (Wird sowieso automatisch gemacht, wenn get, set oder createDB verwendet wird)] + //Überprüfe, ob CouchDB online ist. (Wird sowieso automatisch gemacht, wenn get, set oder createDB verwendet wird) async checkOnlineStatus(); - [Erstellt die Datenbank. (Wird auch automatisch gemacht, wenn man get oder set verwendet)] + //Erstellt die Datenbank. (Wird auch automatisch gemacht, wenn man get oder set verwendet) async createDB(); - [Bekomme das Objekt, was in der Datenbank unter der id gespeichert wurde] + //Bekomme das Objekt, was in der Datenbank unter der id gespeichert wurde async get(string id); - [Setze ein Objekt, was in der Datenbank gespeichert wird (Bedenke: Du musst ein Objekt angeben, alles andere (string, array) wird nicht genommen)] + //Setze ein Objekt, was in der Datenbank gespeichert wird (Bedenke: Du musst ein Objekt angeben, alles andere (string, array) wird nicht genommen) async set(string id, object content, boolean replace = true); } +``` Hinweise: - Du brauchst eigentlich nur get oder set (weil alles andere automatisch gemacht wird) @@ -36,6 +40,7 @@ Hinweise: - Vergiss nicht auth.js einzubinden!!! sonst 💥 **Beispiel:** +``` async function main() { const couchDB = new CouchDB(); await couchDB.set("login", { @@ -48,4 +53,4 @@ async function main() { //Gibt { "username": "bla", "password": "bla" } wieder } main(); - +```