Skip to content

Type-safe react stub streaming calls #304

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

Jump to bottom
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Type-safe react stub streaming calls #304

wants to merge 1 commit into from

Conversation

ruifigueira
Copy link
Contributor

Proposal to add type safety to streaming calls.

Usage:

class MyAgent extends Agent<typeof env, {}> {
  @callable({ streaming: true })
  performStream(response: StreamingResponse<number, string>, result: string): void {
    response.send(1);
    response.send(2);
    response.end(result);
  }
}

const { stub } = useAgent<MyAgent, {}>({ agent: "my-agent" });

stub.performStream({
  onChunk: (chunk) => console.log('streaming: ', chunk),
  onDone: (finalChunk) => console.log('done: ', finalChunk),
}, "hello");

I'm opening this as a draft as I'm not very happy with the current solution, first argument being a StreamOptions doesn't seem right.

I'll gladly accept suggestions on how to improve it.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented May 24, 2025

⚠️ No Changeset found

Latest commit: 76fa487

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ruifigueira
Copy link
Contributor Author

BTW, my idea is to integrate streaming properly into stubs and simplify everything by just keeping type safety in stubs (I think call function adds unnecessary complexity due to args being key optional, and that's why I need RequiredAgentMethods and OptionalAgentMethods types).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ruifigueira