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

Document how to .append() a directory #639

Open
joelmukuthu opened this issue Jan 9, 2023 · 0 comments
Open

Document how to .append() a directory #639

joelmukuthu opened this issue Jan 9, 2023 · 0 comments
Assignees

Comments

@joelmukuthu
Copy link

I think many are aware of archive.append(null, { name:'dir/' }), but since it's not documented it's hard for a newcomer to find out about it. Also, since the docs for .append(source, data) regard source as Buffer | Stream | String, it feels quite like going against the grain with null.

On this note, what do you think about adding some more explicit functions for this i.e. appendFile and appendDirectory that simply proxy to append?

I'd be happy to work on PRs for both of these if needed!

@joelmukuthu joelmukuthu changed the title Document how to append a directory Document how to .append() a directory Jan 14, 2023
@ctalkington ctalkington self-assigned this Sep 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants