Skip to content
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

Additions to the streaming api docs #1371

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Additions to the streaming api docs #1371

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
10 changes: 6 additions & 4 deletions docs/ts/primitives/streaming-apis.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ interface Message {

// messageStream streams out all chat messages for a certain id
export const messageStream = api.streamOut<Handshake, Message>(
{ path: "/chat/:roomId" },
{ path: "/chat/:roomId", expose: true },
async (handshake, stream) => {
// Use `handshake.roomId` to fetch messages
for await (const msg of messages) {
Expand All @@ -59,7 +59,7 @@ interface DataChunk {
}

export const uploadStream = api.streamIn<DataChunk>(
{ path: "/upload" },
{ path: "/upload", expose: true },
async (stream) => {
for await (const data of stream) {
// do something with data
Expand All @@ -80,7 +80,7 @@ interface PongMessage {
}

export const pingpongStream = api.streamInOut<PingMessage, PongMessage>(
{ path: "/pingpong" },
{ path: "/pingpong", expose: true },
async (stream) => {
for await (const ping of stream) {
// do something with the ping payload
Expand Down Expand Up @@ -119,7 +119,7 @@ You can use `authHandler` in the same way as for regular endpoints, just specify

## Connecting with the client

Using the generated client, you can connect to a streaming API endpoint. The client stream acts as an async iterator, allowing you to retrieve messages by simply iterating over it:
Using the generated client, you can connect to a streaming API endpoint that have `expose` set to `true`. The client stream acts as an async iterator, allowing you to retrieve messages by simply iterating over it:

```typescript
const stream = client.serviceName.endpointName();
Expand Down Expand Up @@ -150,3 +150,5 @@ stream.socket.on("close", (event) => {
});

```

Learn more in the [Client Library Generation](/docs/develop/client-generation) docs.
Loading