How to stream files

Hi, I am trying to stream files from local disc (for a reason it’s not served as static).

I tried to use sendStream or send it directly to pipe but each time I get 404. Documentation is not mentioning too much how to use streams. How to use it correctly with h3?

export default defineEventHandler((event) -> 
     const stream = fs.createReadStream(path);
     stream.pipe(event.res);
)

or

const stream = fs.createReadStream(path);
      sendStream(event, stream);

[maciej-jezierski]

I found solution by using playground and checking code. Solution is super simple, sendStream has to be returned directly

const r = "/path/to/file
return sendStream(event, fs.createReadStream(r))

In my case if you have promise first it’s working as well

return $fetch(apiUrl, { method: "GET", parseResponse: JSON.parse }).
    .then(r => sendStream(event, fs.createReadStream(r.path)))

KISS, but generally would be good to add it to documentation before some other people run into this issue as streaming files is common exercise.

[pi0]

@Atinux We should probably start adding examples directly to h3 docs. Otherwise, we will end up with fragmented documentation and outdated info for utils. Also, consider sendStream support is not universal yet.