docs: add examples and docs for SSE support

Author: malcolm-kee

docs/openapi-ts/clients/angular.md

@@ -204,6 +204,68 @@ This section is under construction. We appreciate your patience.
 This section is under construction. We appreciate your patience.
 :::
 
+## Server-Sent Events
+
+When your OpenAPI spec defines endpoints with `text/event-stream` responses, the SDK generates SSE-enabled functions that return an async stream instead of a regular response.
+
+### Consuming a stream
+
+```js
+import { watchStockPrices } from './client/sdk.gen';
+
+const { stream } = await watchStockPrices();
+
+for await (const event of stream) {
+  console.log(event);
+}
+```
+
+### Callbacks
+
+You can use `onSseEvent` and `onSseError` callbacks for additional event and error processing.
+
+```js
+const { stream } = await watchStockPrices({
+  onSseEvent: (event) => {
+    // access event.data, event.event, event.id, event.retry
+  },
+  onSseError: (error) => {
+    console.error('SSE error:', error);
+  },
+});
+```
+
+### Cancellation
+
+Use an `AbortController` to cancel the stream.
+
+```js
+const controller = new AbortController();
+
+const { stream } = await watchStockPrices({
+  signal: controller.signal,
+});
+
+// cancel the stream
+controller.abort();
+```
+
+### Retry
+
+SSE connections automatically reconnect on failure with exponential backoff. You can configure the retry behavior.
+
+```js
+const { stream } = await watchStockPrices({
+  sseDefaultRetryDelay: 3000, // initial retry delay (default: 3000ms)
+  sseMaxRetryAttempts: 5, // max retry attempts
+  sseMaxRetryDelay: 30000, // max retry delay cap (default: 30000ms)
+});
+```
+
+::: warning
+Angular `HttpClient` interceptors do not apply to SSE connections. The SSE client uses the native Fetch API under the hood.
+:::
+
 ## Build URL
 
 If you need to access the compiled URL, you can use the `buildUrl()` method. It's loosely typed by default to accept almost any value; in practice, you will want to pass a type hint.

docs/openapi-ts/clients/angular/v19.md

@@ -204,6 +204,68 @@ This section is under construction. We appreciate your patience.
 This section is under construction. We appreciate your patience.
 :::
 
+## Server-Sent Events
+
+When your OpenAPI spec defines endpoints with `text/event-stream` responses, the SDK generates SSE-enabled functions that return an async stream instead of a regular response.
+
+### Consuming a stream
+
+```js
+import { watchStockPrices } from './client/sdk.gen';
+
+const { stream } = await watchStockPrices();
+
+for await (const event of stream) {
+  console.log(event);
+}
+```
+
+### Callbacks
+
+You can use `onSseEvent` and `onSseError` callbacks for additional event and error processing.
+
+```js
+const { stream } = await watchStockPrices({
+  onSseEvent: (event) => {
+    // access event.data, event.event, event.id, event.retry
+  },
+  onSseError: (error) => {
+    console.error('SSE error:', error);
+  },
+});
+```
+
+### Cancellation
+
+Use an `AbortController` to cancel the stream.
+
+```js
+const controller = new AbortController();
+
+const { stream } = await watchStockPrices({
+  signal: controller.signal,
+});
+
+// cancel the stream
+controller.abort();
+```
+
+### Retry
+
+SSE connections automatically reconnect on failure with exponential backoff. You can configure the retry behavior.
+
+```js
+const { stream } = await watchStockPrices({
+  sseDefaultRetryDelay: 3000, // initial retry delay (default: 3000ms)
+  sseMaxRetryAttempts: 5, // max retry attempts
+  sseMaxRetryDelay: 30000, // max retry delay cap (default: 30000ms)
+});
+```
+
+::: warning
+Angular `HttpClient` interceptors do not apply to SSE connections. The SSE client uses the native Fetch API under the hood.
+:::
+
 ## Build URL
 
 If you need to access the compiled URL, you can use the `buildUrl()` method. It's loosely typed by default to accept almost any value; in practice, you will want to pass a type hint.

docs/openapi-ts/clients/axios.md

@@ -184,6 +184,68 @@ client.instance.interceptors.request.use((config) => {
 });
 ```
 
+## Server-Sent Events
+
+When your OpenAPI spec defines endpoints with `text/event-stream` responses, the SDK generates SSE-enabled functions that return an async stream instead of a regular response.
+
+### Consuming a stream
+
+```js
+import { watchStockPrices } from './client/sdk.gen';
+
+const { stream } = await watchStockPrices();
+
+for await (const event of stream) {
+  console.log(event);
+}
+```
+
+### Callbacks
+
+You can use `onSseEvent` and `onSseError` callbacks for additional event and error processing.
+
+```js
+const { stream } = await watchStockPrices({
+  onSseEvent: (event) => {
+    // access event.data, event.event, event.id, event.retry
+  },
+  onSseError: (error) => {
+    console.error('SSE error:', error);
+  },
+});
+```
+
+### Cancellation
+
+Use an `AbortController` to cancel the stream.
+
+```js
+const controller = new AbortController();
+
+const { stream } = await watchStockPrices({
+  signal: controller.signal,
+});
+
+// cancel the stream
+controller.abort();
+```
+
+### Retry
+
+SSE connections automatically reconnect on failure with exponential backoff. You can configure the retry behavior.
+
+```js
+const { stream } = await watchStockPrices({
+  sseDefaultRetryDelay: 3000, // initial retry delay (default: 3000ms)
+  sseMaxRetryAttempts: 5, // max retry attempts
+  sseMaxRetryDelay: 30000, // max retry delay cap (default: 30000ms)
+});
+```
+
+::: warning
+Axios interceptors registered through `client.instance.interceptors` do not apply to SSE connections. The SSE client uses the native Fetch API under the hood.
+:::
+
 ## Build URL
 
 If you need to access the compiled URL, you can use the `buildUrl()` method. It's loosely typed by default to accept almost any value; in practice, you will want to pass a type hint.

docs/openapi-ts/clients/fetch.md

@@ -262,6 +262,68 @@ client.interceptors.request.use((request, options) => {
 });
 ```
 
+## Server-Sent Events
+
+When your OpenAPI spec defines endpoints with `text/event-stream` responses, the SDK generates SSE-enabled functions that return an async stream instead of a regular response.
+
+### Consuming a stream
+
+```js
+import { watchStockPrices } from './client/sdk.gen';
+
+const { stream } = await watchStockPrices();
+
+for await (const event of stream) {
+  console.log(event);
+}
+```
+
+### Callbacks
+
+You can use `onSseEvent` and `onSseError` callbacks for additional event and error processing.
+
+```js
+const { stream } = await watchStockPrices({
+  onSseEvent: (event) => {
+    // access event.data, event.event, event.id, event.retry
+  },
+  onSseError: (error) => {
+    console.error('SSE error:', error);
+  },
+});
+```
+
+### Cancellation
+
+Use an `AbortController` to cancel the stream.
+
+```js
+const controller = new AbortController();
+
+const { stream } = await watchStockPrices({
+  signal: controller.signal,
+});
+
+// cancel the stream
+controller.abort();
+```
+
+### Retry
+
+SSE connections automatically reconnect on failure with exponential backoff. You can configure the retry behavior.
+
+```js
+const { stream } = await watchStockPrices({
+  sseDefaultRetryDelay: 3000, // initial retry delay (default: 3000ms)
+  sseMaxRetryAttempts: 5, // max retry attempts
+  sseMaxRetryDelay: 30000, // max retry delay cap (default: 30000ms)
+});
+```
+
+::: tip
+Request interceptors registered through `client.interceptors.request` apply to SSE connections, including on each reconnect attempt.
+:::
+
 ## Build URL
 
 If you need to access the compiled URL, you can use the `buildUrl()` method. It's loosely typed by default to accept almost any value; in practice, you will want to pass a type hint.

docs/openapi-ts/clients/ky.md

@@ -260,6 +260,68 @@ client.interceptors.request.use((request, options) => {
 });
 ```
 
+## Server-Sent Events
+
+When your OpenAPI spec defines endpoints with `text/event-stream` responses, the SDK generates SSE-enabled functions that return an async stream instead of a regular response.
+
+### Consuming a stream
+
+```js
+import { watchStockPrices } from './client/sdk.gen';
+
+const { stream } = await watchStockPrices();
+
+for await (const event of stream) {
+  console.log(event);
+}
+```
+
+### Callbacks
+
+You can use `onSseEvent` and `onSseError` callbacks for additional event and error processing.
+
+```js
+const { stream } = await watchStockPrices({
+  onSseEvent: (event) => {
+    // access event.data, event.event, event.id, event.retry
+  },
+  onSseError: (error) => {
+    console.error('SSE error:', error);
+  },
+});
+```
+
+### Cancellation
+
+Use an `AbortController` to cancel the stream.
+
+```js
+const controller = new AbortController();
+
+const { stream } = await watchStockPrices({
+  signal: controller.signal,
+});
+
+// cancel the stream
+controller.abort();
+```
+
+### Retry
+
+SSE connections automatically reconnect on failure with exponential backoff. You can configure the retry behavior.
+
+```js
+const { stream } = await watchStockPrices({
+  sseDefaultRetryDelay: 3000, // initial retry delay (default: 3000ms)
+  sseMaxRetryAttempts: 5, // max retry attempts
+  sseMaxRetryDelay: 30000, // max retry delay cap (default: 30000ms)
+});
+```
+
+::: tip
+Request interceptors registered through `client.interceptors.request` apply to SSE connections, including on each reconnect attempt.
+:::
+
 ## Build URL
 
 If you need to access the compiled URL, you can use the `buildUrl()` method. It's loosely typed by default to accept almost any value; in practice, you will want to pass a type hint.