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.

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

Update file-io.md: BunFile.stream() doesn't return promise #7372

Merged
merged 1 commit into from Nov 29, 2023

Conversation

NReilingh
Copy link
Contributor

Based on testing, .stream() returns a ReadableStream directly instead of a Promise.

What does this PR do?

Fixes the type signature reference for BunFile in the docs.

  • Documentation or TypeScript types (it's okay to leave the rest blank in this case)
  • Code changes

According to my lsp, `.stream()` returns a ReadableStream directly instead of a promise.
@Electroid Electroid merged commit ebae02a into oven-sh:main Nov 29, 2023
@Electroid
Copy link
Contributor

Thanks for fixing this, we missed it.

@NReilingh NReilingh deleted the patch-1 branch November 30, 2023 23:58
ryoppippi pushed a commit to ryoppippi/bun that referenced this pull request Feb 1, 2024
)

According to my lsp, `.stream()` returns a ReadableStream directly instead of a promise.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants