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

Publish TypeScript type definitions #29

Closed
carlpaten opened this issue Dec 27, 2022 · 3 comments
Closed

Publish TypeScript type definitions #29

carlpaten opened this issue Dec 27, 2022 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@carlpaten
Copy link

TypeScript type definitions are lovely for learning a new library. I'd love to benefit from these here.

@imiric
Copy link
Contributor

imiric commented Jan 23, 2023

Hi there, sorry about the late response.

I agree that this would be helpful, but I don't use TypeScript for k6 scripts, and currently don't have the bandwidth to look into this. If someone else can contribute it, we'd be happy to merge it.

@imiric imiric added enhancement New feature or request help wanted Extra attention is needed labels Jan 23, 2023
@leandrodotec
Copy link
Contributor

Hi, I have just made the definitions,

DefinitelyTyped/DefinitelyTyped#65750

What do you guys think?

@imiric
Copy link
Contributor

imiric commented Jun 14, 2023

Hi @leandrodotec, and thanks submitting that PR.

Unfortunately, after internal discussion, the team has decided to not support type definitions for k6 extensions, including xk6-sql. This means that we can't accept a PR that adds the definitions to the @types/k6 package, since it would add a maintenance burden we currently don't have the capacity for.

We're terribly sorry for the inconvenience and miscommunication. We encourage you to either create a secondary package in the DefinitelyTyped repo which you or someone else would maintain, or to add the definitions to a fork of this repo, and import them directly from there.

When, and if, this extension becomes part of the k6 repository, then we would consider adding the definitions to @types/k6, but not before. Thanks for understanding, and sorry again.

@imiric imiric closed this as not planned Won't fix, can't repro, duplicate, stale Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants