Skip to content

docs: document downloadToResponse export #4

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
danielroe merged 2 commits into from
Nov 6, 2025
Merged

docs: document downloadToResponse export #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
849f22f
Initial plan
Copilot Nov 6, 2025
080ea27
docs: add downloadToResponse to README
Copilot Nov 6, 2025
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
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,14 @@ await downloadToFile({
### Web APIs

```typescript
import { downloadToBlob, parseUrl } from 'stackblitz-zip'
import { downloadToBlob, downloadToResponse, parseUrl } from 'stackblitz-zip'

// download as Blob (browser-friendly)
// download as Web Response (edge runtimes, servers)
const projectId = parseUrl('https://stackblitz.com/edit/nuxt-starter-k7spa3r4')
const response = await downloadToResponse({ projectId })
// response can be returned directly from edge functions

// or download as Blob (browser-friendly)
const blob = await downloadToBlob({ projectId })

// trigger browser download
Expand Down Expand Up @@ -136,6 +140,14 @@ Downloads a StackBlitz project and returns the path to the created zip file.
- `maxTotalSize` (number, optional): Maximum total project size in bytes. Defaults to `104857600` (100MB)
- `verbose` (boolean, optional): Enable console logging. Defaults to `false`

### `downloadToResponse(options): Promise<Response>`

Downloads a StackBlitz project and returns it as a Web Response (universal).

**Options:** Same as `downloadToFile` except `outputPath`

**Returns:** A Response object containing the zip file stream

### `downloadToBuffer(options): Promise<ArrayBuffer>`

Downloads a StackBlitz project and returns it as an ArrayBuffer (universal).
Expand Down