Skip to content

docs: add await operator to ctx.sendEvents() call #708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
egorkonovalov wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add await operator to ctx.sendEvents() call #708

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/sse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import { Application, Router } from "https://deno.land/x/oak/mod.ts";
const app = new Application();
const router = new Router();

router.get("/sse", (ctx) => {
const target = ctx.sendEvents();
router.get("/sse", async (ctx) => {
const target = await ctx.sendEvents();
target.dispatchMessage({ hello: "world" });
});

Expand All @@ -33,8 +33,8 @@ The far end can close the connection, which can be detected by the `close` event
on the target:

```ts
router.get("/sse", (ctx) => {
const target = ctx.sendEvents();
router.get("/sse", async (ctx) => {
const target = await ctx.sendEvents();
target.addEventListener("close", (evt) => {
// perform some cleanup activities
});
Expand All @@ -46,7 +46,7 @@ The server side can also close the connection:

```ts
router.get("/sse", async (ctx) => {
const target = ctx.sendEvents();
const target = await ctx.sendEvents();
target.dispatchMessage({ hello: "world" });
await target.close();
});
Expand All @@ -65,7 +65,7 @@ server and dispatched via the `ServerSentEventTarget` will be raised as a

```ts
router.get("/sse", async (ctx: Context) => {
const target = ctx.sendEvents();
const target = await ctx.sendEvents();
const event = new ServerSentEvent("ping", { hello: "world" });
target.dispatchEvent(event);
});
Expand Down Expand Up @@ -123,7 +123,7 @@ when calling `.sendEvents()`:
```ts
router.get("/sse", async (ctx: Context) => {
const headers = new Headers([["X-Custom-Header", "custom value"]]);
const target = ctx.sendEvents({ headers });
const target = await ctx.sendEvents({ headers });
const event = new ServerSentEvent("ping", { hello: "world" });
target.dispatchEvent(event);
});
Expand Down