Skip to content
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.

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

docs should warn loudly that archiver doesn't use bonafide Node streams #765

Open
jedwards1211 opened this issue Jun 1, 2024 · 0 comments · May be fixed by #799
Open

docs should warn loudly that archiver doesn't use bonafide Node streams #765

jedwards1211 opened this issue Jun 1, 2024 · 0 comments · May be fixed by #799

Comments

@jedwards1211
Copy link

A lot of people know about the .pipe(new PassThrough()) workaround for working with tools like AWS SDK v3, but it's completely undocumented that this is necessary or why.

The docs should have warnings/troubleshooting pages that explain loud and clear that archiver uses the readable-stream userland implementation and this causes issues with any tools that expect a bonafide Node Readable instance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant