DashletOptions

Das options-Argument von installDashletGlobal(options). Jedes Feld ist optional; die Bibliothek läuft mit voll funktionierenden Standardwerten.

1. Signatur

interface DashletOptions {
    expectedOrigin?: string | null;
    timeoutMs?: number;
    pollIntervalMs?: number;
    detectionTimeoutMs?: number;
    window?: WindowLike;
}

2. Parameter

Name Typ Standard Beschreibung

expectedOrigin

string | null

—

Der Origin des Webclient-Hosts, der Nachrichten senden darf (z. B. https://enaio.example.com). Pro Deployment konfiguriert — niemals hartkodiert, und niemals "*". Ein nutzbarer Wert schaltet den Wire in den strengen Modus und deaktiviert das Origin-Lernen; weggelassen läuft der Wire im lernenden Modus in einem iframe (der vertrauenswürdige Origin wird aus dem ersten onInit erlernt). Der Desktop-App-Host-Origin ist der String "null" (plus die Legacy-Serialisierungen file://, file:///, file — eine Gruppe, bidirektional). Jeder andere nicht-URL-, nicht-Gruppen-Wert wird zur Installzeit mit einer beschreibenden TypeError abgelehnt. Details: Origin-Konfiguration.

timeoutMs

number

5000

Standard-Antwort-Timeout in Millisekunden für jeden Methodenaufruf — Webclient-Wire-Aufrufe und die begrenzten Standalone-Ablehnungen. Bei Timeout lehnt der Aufruf mit dem begrenzten TimeoutError ab (siehe Fehler).

pollIntervalMs

number

50

Rich-Client-Bridge-Poll-Intervall in Millisekunden — wie oft window.osClient beprobt wird, bis es erscheint oder die Erkennungs-Obergrenze abläuft.

detectionTimeoutMs

number

5000

Erkennungs-Obergrenze in Millisekunden: wie lange das Dashlet nach einer Bridge sucht / auf ein onInit wartet, bevor es den Standalone-Zustand meldet.

window

WindowLike

aktuelles globales window

Das Fenster-Objekt, mit dem die Bibliothek arbeitet. Standardmäßig das aktuelle globale window; in Unit-Tests injizierbar (die Bibliothek trägt keine weitere Umgebungs-Annahme).

Relevanz pro Umgebung:

Umgebung Relevante Optionen

webclient

expectedOrigin (streng vs. lernend), timeoutMs

rich client

pollIntervalMs, detectionTimeoutMs

standalone

detectionTimeoutMs (wann der Zustand erreicht wird), timeoutMs (wie schnell jeder Fassade-Aufruf abgelehnt wird)

3. Beispiele

const dashlet = installDashletGlobal({
    expectedOrigin: 'https://enaio.example.com', // strenger Modus
    timeoutMs: 5000,          // Standard
    pollIntervalMs: 50,       // Standard
    detectionTimeoutMs: 5000, // Standard
});

// lernender Modus: expectedOrigin weglassen
const dashlet2 = installDashletGlobal({});

4. Fehler

  • TypeError zur Installzeit für expectedOrigin-Werte, die niemals gültig sein können ("*", oder ein Wert, der weder eine absolute URL noch ein Mitglied der file-Origin-Gruppe ist) — die Ablehnung erfolgt zur Installzeit, nicht zur Post-Zeit (Origin-Konfiguration).