Skip to content

feat: add typescript definition#153

Open
alvis wants to merge 5 commits intomafintosh:masterfrom
alvis:typing
Open

feat: add typescript definition#153
alvis wants to merge 5 commits intomafintosh:masterfrom
alvis:typing

Conversation

@alvis
Copy link
Copy Markdown

@alvis alvis commented Jun 19, 2023

close #97

@catdevnull
Copy link
Copy Markdown

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

index.d.ts Outdated
entry(header: HeaderForPack, callback?: (error?: Error) => void): Sink
entry(
header: HeaderForPack,
buffer: string | Buffer,
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown

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
Copy Markdown
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
Copy Markdown

a-eid commented Apr 9, 2024

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PR for typescript definition?

5 participants