fs module should support writing from Blob and web ReadableStream sources
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 122k
- Forks
- 37.3k
- Merge medio
- 4 d 2 h
- PR fusionados (30 d)
- 283
Descripción
What is the problem this feature will solve?
Currently, all Node.js fs module methods for writing data (such as fs.write, fs.createWriteStream) only accept Buffers or strings. There is no built-in support for writing data directly from Blob or web ReadableStream sources. This limits interoperability with web platform APIs and makes working with large files or streaming data @less seamless, especially when trying to move data efficiently from web contexts into the filesystem. Furthermore, Node.js provides fs.readableWebStream, but no corresponding fs.createWritableStream that would allow writing from web streams or Blobs directly.
What is the feature you are proposing to solve the problem?
Extend the Node.js fs module with the following capabilities:
- Allow fs.write and related write methods to accept Blob objects as a valid input, making it possible to write the entirety of a Blob's contents to a file without manual conversion to Buffer.
- Introduce fs.createWritableStream (web-compatible), which would be a direct counterpart to fs.readableWebStream and support writing from web ReadableStream sources to files.
This would improve ease-of-use when working with large binary/web platform data and make fs more aligned with modern web standards.
What alternatives have you considered?
Current workarounds involve manually converting Blobs and web streams into Buffers or converting web streams into node:streams
The only solution we have today is to use the fs.promise.writeFile(path, webStream) which luckily supports async iterable
with that in mind, the NodeJS document for...
... filehandle.appendFile(data[, options]) says it support:
data: <string> | <Buffer> | <TypedArray> | <DataView> | <AsyncIterable> | <Iterable> | <Stream>
it should also say
data: <string> | <Buffer> | <TypedArray> | <DataView> | <AsyncIterable> | <Iterable> | <Stream> | <ReadableStream>
or just
data: <string> | <Buffer> | <TypedArray> | <DataView> | <AsyncIterable> | <Iterable>
as stream's are async iterable
and i also do not thing it should say Buffer anymore... buffer is a typed array already... so it can just say:
data: <string> | <TypedArray> | <DataView> | <AsyncIterable> | <Iterable>
but this is just only off-topic
able to write Blob's would enable efficient native copy operations (like using openAsBlob(path) and writing directly to another file) without data passing through the JS runtime.
able to write blobs avoids extra conversions/allocations in JS, reduces memory footprint and GC pressure
the solution i'm looking for is something like:
blob = new Blob(['hello world'])
await filehandle.write(blob)
await blob.stream().pipeTo(fs.createWritableStream(dest))
// using fetch is becoming more popular, so a web writable stream is highly requested
await new Response('...').body.pipeTo(fs.createWritableStream(dest))
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Lee primero el comportamiento existente de fs.write, fs.promises.writeFile, fs.readableWebStream y filehandle.appendFile, y compáralo después con los casos de Blob y web ReadableStream del issue. Se considera terminado cuando se haya acordado el alcance admitido y las APIs de escritura solicitadas gestionen los casos de uso de Blob y web-stream indicados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, nodejs
- Área
- operating-systems
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100