Zum Hauptinhalt springen
app.realtime() öffnet einen Server-Sent-Events-Stream und liefert die rohe Response. Das SDK parst die SSE-Frames nicht für dich — es gibt dir den Stream, damit du ihn in deine eigene Event-Loop einbinden kannst.

​
Verbindungslimits

  • Jede Verbindung dauert bis zu 10 Minuten, danach schließt der Server sie
  • Ein einzelnes Konto kann höchstens 10 gleichzeitige Verbindungen offen halten

​
Form der Ereignisse

Der Stream sendet zwei Arten von Frames:
  • event: system — Nachrichten zum Verbindungslebenszyklus wie REALTIME_CONNECTING, REALTIME_TIMEOUT usw.
  • event: message — die JSON-Anwendungs-Payload

​
Konsumieren des Streams

import { SquareCloudAPI } from "@squarecloud/api";

const api = new SquareCloudAPI(process.env.SQUARE_API_KEY!);
const app = await api.applications.fetch("abc123def456abc123def456");

const response = await app.realtime();

if (!response.body) {
    throw new Error("No stream body");
}

const reader = response.body.pipeThrough(new TextDecoderStream()).getReader();
let buffer = "";

while (true) {
    const { value, done } = await reader.read();
    if (done) break;

    buffer += value;

    // SSE frames are separated by \n\n
    let separator = buffer.indexOf("\n\n");
    while (separator !== -1) {
        const rawFrame = buffer.slice(0, separator);
        buffer = buffer.slice(separator + 2);
        separator = buffer.indexOf("\n\n");

        const event = parseSSE(rawFrame);
        if (!event) continue;

        if (event.name === "system") {
            console.log(`[system] ${event.data}`);
            continue;
        }

        try {
            const payload = JSON.parse(event.data);
            console.log("[message]", payload);
        } catch {
            console.log("[message]", event.data);
        }
    }
}

function parseSSE(frame: string): { name: string; data: string } | null {
    let name = "message";
    let data = "";

    for (const line of frame.split("\n")) {
        if (line.startsWith("event:")) name = line.slice(6).trim();
        else if (line.startsWith("data:")) data += line.slice(5).trim();
    }

    return data ? { name, data } : null;
}
Jeder Aufruf von app.realtime() liefert eine frische Response. Um über das serverseitige 10-Minuten-Timeout hinaus verbunden zu bleiben, stelle die Verbindung wieder her, wenn der Stream endet.