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

Add type definitions #20

Closed
TaylorBeeston opened this issue Jul 15, 2020 · 2 comments · Fixed by #21
Closed

Add type definitions #20

TaylorBeeston opened this issue Jul 15, 2020 · 2 comments · Fixed by #21
Labels
☂️ area/types This affects typings 💪 phase/solved Post is done 🧑 semver/major This is a change 🦋 type/enhancement This is great to have

Comments

@TaylorBeeston
Copy link
Contributor

Subject of the feature

Add TypeScript type definitions

Problem

It is currently difficult to use this package in a TypeScript project due to a lack of type definitions. This in turn also makes it different to add type definitions to a package that depends on this package.

Expected behaviour

When importing this module into a TypeScript project, the type should automatically be declared.

Alternatives

An alternative to simply adding a .d.ts file would be to actually convert the whole package to TypeScript, however, it is much easier to simply add a .d.ts file.
@TaylorBeeston TaylorBeeston added 🙉 open/needs-info This needs some more info 🦋 type/enhancement This is great to have labels Jul 15, 2020
@ChristianMurphy ChristianMurphy added good first issue 👋 This may be a great place to get started! help wanted 🙏 This could use your insight or help ☂️ area/types This affects typings 🙆 yes/confirmed This is confirmed and ready to be worked on 🦋 type/enhancement This is great to have 🧑 semver/major This is a change and removed 🙉 open/needs-info This needs some more info 🦋 type/enhancement This is great to have labels Jul 15, 2020
@ChristianMurphy
Copy link
Member

Pull request(s) are welcome!

@ChristianMurphy ChristianMurphy linked a pull request Jul 16, 2020 that will close this issue
Add type definitions #21
Merged
wooorm pushed a commit that referenced this issue Jul 20, 2020
@TaylorBeeston
Add types
38c2aa8 
Closes GH-20.
Closes GH-21.

Reviewed-by: Jonathan Haines <jonno.haines@gmail.com>
Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>
Reviewed-by: Titus Wormer <tituswormer@gmail.com>
@wooorm
Copy link
Member

wooorm commented Jul 20, 2020

Released!

@wooorm wooorm added ⛵️ status/released and removed good first issue 👋 This may be a great place to get started! help wanted 🙏 This could use your insight or help 🙆 yes/confirmed This is confirmed and ready to be worked on labels Jul 20, 2020
@wooorm wooorm added the 💪 phase/solved Post is done label Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
☂️ area/types This affects typings 💪 phase/solved Post is done 🧑 semver/major This is a change 🦋 type/enhancement This is great to have
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add type definitions TaylorBeeston/hast-util-sanitize
3 participants
@wooorm @ChristianMurphy @TaylorBeeston