nodejs / nodejs/node

fs module should support writing from Blob and web ReadableStream sources

Đang mở
#61,684 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

feature request
Ngôn ngữ chính
JavaScript
Star
122k
Fork
37.3k
Merge trung bình
4 ngày 2 giờ
Pull request đã merge (30 ngày)
283

Mô tả

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))

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Trước tiên, hãy đọc hành vi hiện có của fs.write, fs.promises.writeFile, fs.readableWebStream và filehandle.appendFile, sau đó so sánh với các trường hợp Blob và web ReadableStream trong issue. Công việc được xem là hoàn tất khi phạm vi được hỗ trợ đã được thống nhất và các API ghi được yêu cầu xử lý các trường hợp sử dụng Blob và web-stream đã nêu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript, nodejs
Lĩnh vực
operating-systems
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
42/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.