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.

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

feat: type for module #7

Merged
merged 2 commits into from
May 3, 2020
Merged

feat: type for module #7

merged 2 commits into from
May 3, 2020

Conversation

danielroe
Copy link
Contributor

This adds minimal TypeScript support.

@googlebot
Copy link
Collaborator

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@danielroe
Copy link
Contributor Author

@googlebot I signed it!

@googlebot
Copy link
Collaborator

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@developit developit self-requested a review May 3, 2020 02:48
@developit
Copy link
Owner

Hi @danielroe - I am wondering if you know of a way to have this import the existing typings for Worker from TypeScript's dom.d.ts. I'm not super handy with TS definitions, but I think that might be the way for us to ensure this module remains transparent.

@danielroe
Copy link
Contributor Author

@developit Couldn't agree more. But you wouldn't need to import it.

Someone who is consuming this library will probably already have a tsconfig that includes:

{
  "compilerOptions": {
    "lib": ["dom"]
  }
}

Given that, the index.d.ts I've proposed here will inform TS that your module can be instantiated to return a Worker, according to the type defined in the dom library.

@developit
Copy link
Owner

Oh, awesome! That seems obvious now from looking at the code, apologies for my misinterpretation.

@developit developit merged commit 4a46d3a into developit:master May 3, 2020
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.

3 participants