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.

Sign up for GitHub

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

Jump to bottom

feat: add typescript definition #153

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

feat: add typescript definition #153

wants to merge 5 commits into from
+67 −0

Conversation

alvis
Copy link

@alvis alvis commented Jun 19, 2023

close #97

@catdevnull
Copy link

this doesn't seem to implement the async iterator things. neither does @types/tar-stream.

mafintosh
mafintosh reviewed Jun 20, 2023
View reviewed changes
index.d.ts Outdated
entry(header: HeaderForPack, callback?: (error?: Error) => void): Sink
entry(
header: HeaderForPack,
buffer: string | Buffer,
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

buffer is optional

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. When buffer is not provided, the signature would be the one on line 23.

@alvis
Copy link
Author

alvis commented Jul 21, 2023

this doesn't seem to implement the async iterator things. neither does @types/tar-stream.

Thanks for reminding. Now the updated version includes the missing async iterator.

@mafintosh Please check again :)

@aripalo
Copy link

aripalo commented Aug 22, 2023

Great work @alvis 👍 I was about to start defining the types myself as the @types/tar-stream doesn't have the async iterator. Now I was able to copy-paste the definition until this PR is merged.

@alvis alvis requested a review from mafintosh October 10, 2023 05:39
@alvis
Copy link
Author

alvis commented Feb 28, 2024

@mafintosh let's do a review and let me know if there's anything missing 😎

@a-eid
Copy link

a-eid commented Apr 9, 2024 •
edited

any updates on this PR, any chance it'll be merged soon ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@a-eid a-eid a-eid approved these changes

@mafintosh mafintosh Awaiting requested review from mafintosh

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PR for typescript definition?
5 participants
@alvis @catdevnull @aripalo @a-eid @mafintosh