← Cloudflare Workers / workers / runtime-apis

EventSource

EventSource ↗ rozhraní je API pro události odesílané serverem (server-sent events), které serveru umožňuje odesílat události klientovi. EventSource objekt se používá k příjmu server-sent events. Připojuje se k serveru přes HTTP a přijímá události v textovém formátu.

let eventSource = new EventSource(url, options);

• url USVString - URL, ke které se má připojit.
• options EventSourceInit, volitelný slovník obsahující libovolná volitelná nastavení.

Ve výchozím nastavení EventSource použije globální fetch() funkci pod pokličkou k vytváření požadavků. Pokud potřebujete použít jinou implementaci fetch, kterou poskytuje vazba Cloudflare Workers, můžete předat fetcher možnost:

export default {
  async fetch(req, env) {
    let eventSource = new EventSource(url, { fetcher: env.MYFETCHER });
    // ...
  }
};

Upozorňujeme, že fetcher možnost je rozšíření specifické pro Cloudflare Workers.

• eventSource.url USVString jen pro čtení
  • URL adresa zdroje události.
• eventSource.readyState USVString jen pro čtení
  • Stav připojení.
• eventSource.withCredentials Boolean, jen pro čtení
  • Booleovská hodnota označující, zda EventSource objekt byl vytvořen s nastavenými přihlašovacími údaji pro cross-origin (CORS) (true), nebo ne (false).

• eventSource.close()
  • Zavře připojení.
• eventSource.onopen
  • Obslužná rutina události, která se volá při otevření připojení.
• eventSource.onmessage
  • Obslužná rutina události, která se volá při přijetí zprávy.
• eventSource.onerror
  • Obslužná rutina události, která se volá při výskytu chyby.

• message
  • Vyvolá se při přijetí zprávy.
• open
  • Vyvolá se při otevření připojení.
• error
  • Vyvolá se při výskytu chyby.

• EventSource.from(readableStreamReadableStream) : EventSource
  • Toto je rozšíření specifické pro Cloudflare Workers, které vytvoří nový EventSource objekt z existujícího ReadableStream. Taková instance nezahajuje nové připojení, ale místo toho se připojí k poskytnutému streamu.