Uh oh!
There was an error while loading. Please reload this page.
Convert to TypeScript - #27
Conversation
In order to align this repo with our other repos, this commit converts the existing JavaScript to TypeScript, and adds the dependencies and configuration to support this. It also adds `typedoc` and updates the existing GitHub workflows to publish documentation. This means we no longer need to explicitly ship type definitions as they will be generated automatically. Finally, there were a couple of standardization-related things that were missed in previous updates, so this adds those as well. After this commit this repo should be fully compliant with the module template.
a253615 to
0fc1960CompareUh oh!
There was an error while loading. Please reload this page.
This reverts commit dc618e5.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
mcmire
commented
Feb 24, 2023
@Gudahtt Question: since we are importing the EventEmitter type and since that type comes from |
Gudahtt
commented
Feb 24, 2023
Good question. If this were any other library, I'd say yes. But I'm not sure here because it's for a built-in API. Hmm. |
Uh oh!
There was an error while loading. Please reload this page.
We could create a lightweight type representing just the EventEmitter methods we rely on here. That would avoid needing to use that type directly in the It'd improve this package's compatibility with browser environments as well, letting us remove that eslint ignore comment about us using a Node.js module. |
mcmire
commented
Feb 24, 2023
EventEmitterLike added in 6b61eac. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
mcmire
commented
Feb 24, 2023
I need to confirm that these updates don't cause any issues with MetaMask/core#1091. |
This reverts commit d468c5d.
mcmire
commented
Feb 24, 2023
@Gudahtt Okay, MetaMask/core#1091 still passes all tests with this change, so this is good for re-approval. |
In order to align this repo with our other repos, this commit converts the existing JavaScript to TypeScript, and adds the dependencies and configuration to support this. It also adds
typedocand updates the existing GitHub workflows to publish documentation. This means we no longer need to explicitly ship type definitions as they will be generated automatically.Finally, there were a couple of standardization-related things that were missed in previous updates, so this adds those as well. After this commit this repo should be fully compliant with the module template.
Closes#1.