Merge pull request #94 from MatthewWid/fetch-docs

Fetch API Documentation

Author: MatthewWid

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.15.0 - 2025-05-22
+
 ### Added
 
 * Added support for the `Session` constructor to be able to take in a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) (and optionally a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)) object from the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).

docs/src/content/docs/guides/batching.mdx

@@ -14,48 +14,50 @@ While SSE is already performant and bandwidth-efficient, sending many events at
 
 ## Using the `batch` method
 
-To batch and send multiple events at a time, simply invoke [`Session#batch`](/better-sse/reference/api#sessionbatch-batcher-eventbuffer--buffer-eventbuffer--void--promisevoid--promisevoid) method and pass a callback that takes an [event buffer](/better-sse/reference/api#eventbuffer) as its first argument:
+To batch and send multiple events at a time, simply invoke the [`Session#batch`](/better-sse/reference/api#sessionbatch-batcher-eventbuffer--buffer-eventbuffer--void--promisevoid--promisevoid) method and pass a callback that takes an [event buffer](/better-sse/reference/api#eventbuffer) as its first argument:
 
 ```typescript title="server.ts"
 await session.batch(async (buffer) => {
     await buffer.iterate(["My", "huge", "event", "list"]);
 });
 ```
 
-You can use the same helper methods as you would with the session itself ([`push`](/better-sse/reference/api#sessionpush-data-unknown-eventname-string-eventid-string--this), [`stream`](/better-sse/reference/api#sessionstream-stream-readable-options-object--promiseboolean) and [`iterate`](/better-sse/reference/api#sessioniterate-iterable-iterable--asynciterable-options-object--promisevoid)) with the buffer.
+You can use the same helper methods as you would with the session itself ([`push`](/better-sse/reference/api#sessionpush-data-unknown-eventname-string-eventid-string--this), [`stream`](/better-sse/reference/api#sessionstream-stream-streamreadable--readablestream-options-object--promiseboolean) and [`iterate`](/better-sse/reference/api#sessioniterate-iterable-iterable--asynciterable-options-object--promisevoid)) with the buffer.
 
 When the callback finishes execution - or resolves if it returns a promise - every event created with the buffer will be sent to the client all at once in a single network transmission.
 
 <Aside>
-    Events created with event buffers do not use the underlying `Session#push` method and will *not* trigger the `push` event to be emitted on the session instance.
+    Events created with event buffers do **not** use the underlying `Session#push` method and will *not* trigger the `push` event to be emitted on the session instance.
 </Aside>
 
 ## Create your own event buffer
 
 You can also create an event buffer outside of the context of a single session and then write its contents to one or many sessions later on. To do so, create an event buffer and then pass it directly to the `batch` method:
 
 ```typescript title="server.ts"
-import { createEventBuffer } from "better-sse";
+import { createEventBuffer } from "better-sse"
 
-const buffer = createEventBuffer();
+const buffer = createEventBuffer()
 
-buffer.push("One");
-buffer.push("Two");
-buffer.push("Three");
+buffer.push("One")
+buffer.push("Two")
+buffer.push("Three")
 
-session.batch(buffer);
+await session.batch(buffer)
 ```
 
-Or send the buffer contents to every session on a [channel](/better-sse/guides/channels), for example:
+Or send the buffer contents to every session on a channel, for example:
 
 ```typescript title="server.ts"
-channel.activeSessions.forEach((session) => {
-    session.batch(buffer);
-});
+await Promise.all(
+    channel.activeSessions.map((session) =>
+        session.batch(buffer)
+    )
+)
 ```
 
-<Aside title="Sanitize your data" type="caution" >
-    Keep in mind that, unless you explicitly pass them via [the `sanitizer` and/or `serializer` constructor arguments](/better-sse/reference/api/#new-eventbufferoptions-), event buffers do *not* have the same data serializer and sanitizer functions as the session being called.
+<Aside title="Sanitize your data" type="caution">
+    Keep in mind that, unless you explicitly pass them via [the `sanitizer` and/or `serializer` constructor arguments](/better-sse/reference/api/#new-eventbufferoptions-eventbufferoptions), event buffers do **not** have the same data serializer and sanitizer functions as the session being called.
 
     This does not apply when you use the [`Session#batch`](/better-sse/reference/api/#sessionbatch-batcher-eventbuffer--buffer-eventbuffer--void--promisevoid--promisevoid) method as it will automatically copy the serializer and sanitizer from the session to the event buffer instance it creates for you.
 </Aside>
@@ -65,9 +67,9 @@ channel.activeSessions.forEach((session) => {
 For users needing more fine-grained control over the exact data being sent over the wire, event buffers also allow you to write [raw spec-compliant SSE fields](https://html.spec.whatwg.org/multipage/server-sent-events.html#processField) into a string that can be read and sent over the wire as-is.
 
 ```typescript title="server.ts"
-import { createEventBuffer } from "better-sse";
+import { createEventBuffer } from "better-sse"
 
-const buffer = createEventBuffer();
+const buffer = createEventBuffer()
 
 buffer
   .retry(2400)
@@ -76,11 +78,11 @@ buffer
   .data("one")
   .data("two")
   .data("three")
-  .dispatch();
+  .dispatch()
 
-res.write(buffer.read());
+res.write(buffer.read())
 
-buffer.clear();
+buffer.clear()
 ```
 
 This is an advanced use-case. For most users, you should still stick with using [`Session`](/better-sse/reference/api#sessionstate) by default.