DefinitelyTyped
DefinitelyTyped copied to clipboard
[color-hash] Types for version 2.0
Please fill in this template.
- [x] Use a meaningful title for the pull request. Include the name of the package modified.
- [x] Test the change in your own code. (Compile and run.)
- [x] Add or edit tests to reflect the change.
- [x] Follow the advice from the readme.
- [x] Avoid common mistakes.
- [x] Run
pnpm test <package to test>
.
Select one of these and delete the others:
If changing an existing definition:
- [x] Provide a URL to documentation or source code which provides context for the suggested changes: https://github.com/zenozeng/color-hash/blob/main/CHANGELOG.md#v200
- [x] If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the
package.json
.
Version 2.0 released 2 years ago, the library was rewritten to typescript, however it does not come bundled with a .d.ts file. There is an issue open for this: https://github.com/zenozeng/color-hash/issues/38, however the author has not responded to it. The changes I'm making are:
- include string
'bkdr'
as a valid hash function (https://github.com/zenozeng/color-hash/blob/5f717328a019f94bded34b88028105a7f467653d/mod.ts#L46), - export utility types
I am not sure about the export =
vs export default
situation here - the source code uses export default ColorHash
, but the distributed package uses exports["default"] = ColorHash
. I hope this is correct.
@Akatroj Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.
This is a live comment which I will keep updated.
1 package in this PR
Code Reviews
Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.
You can test the changes of this PR in the Playground.
Status
- ✅ No merge conflicts
- ✅ Continuous integration tests have passed
- ✅ Most recent commit is approved by type definition owners or DT maintainers
All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.
Diagnostic Information: What the bot saw about this PR
{
"type": "info",
"now": "-",
"pr_number": 69536,
"author": "Akatroj",
"headCommitOid": "5b538b8ea1786a16f85bab5dfc7cede29563c898",
"mergeBaseOid": "ce432dd83521beac5e46b4e82cdc1d86d963518a",
"lastPushDate": "2024-05-06T16:34:29.000Z",
"lastActivityDate": "2024-05-31T09:37:47.000Z",
"mergeOfferDate": "2024-05-29T16:40:29.000Z",
"mergeRequestDate": "2024-05-31T09:37:47.000Z",
"mergeRequestUser": "Akatroj",
"hasMergeConflict": false,
"isFirstContribution": true,
"tooManyFiles": false,
"hugeChange": false,
"popularityLevel": "Popular",
"pkgInfo": [
{
"name": "color-hash",
"kind": "edit",
"files": [
{
"path": "types/color-hash/color-hash-tests.ts",
"kind": "test"
},
{
"path": "types/color-hash/index.d.ts",
"kind": "definition"
},
{
"path": "types/color-hash/package.json",
"kind": "package-meta-ok"
}
],
"owners": [
"JohannesHoppe",
"ksocha"
],
"addedOwners": [],
"deletedOwners": [],
"popularityLevel": "Popular"
}
],
"reviews": [
{
"type": "approved",
"reviewer": "sheetalkamat",
"date": "2024-05-29T16:39:52.000Z",
"isMaintainer": true
}
],
"mainBotCommentID": 2096454083,
"ciResult": "pass"
}
🔔 @JohannesHoppe @ksocha — please review this PR in the next few days. Be sure to explicitly select Approve
or Request Changes
in the GitHub UI so I know what's going on.
Re-ping @JohannesHoppe, @ksocha:
This PR has been out for over a week, yet I haven't seen any reviews.
Could someone please give it some attention? Thanks!
It has been more than two weeks and this PR still has no reviews.
I'll bump it to the DT maintainer queue. Thank you for your patience, @Akatroj.
(Ping @JohannesHoppe, @ksocha.)
@Akatroj: Everything looks good here. I am ready to merge this PR (at 5b538b8) on your behalf whenever you think it's ready.
If you'd like that to happen, please post a comment saying:
Ready to merge
and I'll merge this PR almost instantly. Thanks for helping out! :heart:
(@JohannesHoppe, @ksocha: you can do this too.)
Ready to merge