Skip to content

Add documentation for duplex property in streaming upload #145

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

Merged
madebydavid merged 2 commits into from
Jan 22, 2026
Merged

Add documentation for duplex property in streaming upload #145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac65e6c
Initial plan
Copilot Jan 22, 2026
041bf57
Add explanatory comment for duplex property type assertion
Copilot Jan 22, 2026
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
6 changes: 6 additions & 0 deletions src/utils/upload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ export function uploadZip({url, zipStream, zipSize, onProgress}: UploadProps): P
const streamWithProgress = zipStream.pipe(progressStream)
const webStream = Readable.toWeb(streamWithProgress) as ReadableStream<Uint8Array>

// The 'duplex' property is required when using a ReadableStream as the request body.
// 'duplex: half' indicates half-duplex communication (one direction at a time),
// which is the mode needed for streaming request bodies with fetch().
// Type assertion is necessary because 'duplex' is not yet part of the standard
// TypeScript RequestInit type definition, though it's required by the fetch spec
// for streaming uploads.
const response = fetch(url, {
method: 'PUT',
headers: {
Expand Down