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

Add TypeScript API declaration file #443

Open
szkiba opened this issue Dec 18, 2024 · 0 comments
Open

Add TypeScript API declaration file #443

szkiba opened this issue Dec 18, 2024 · 0 comments

Comments

@szkiba
Copy link
Contributor

szkiba commented Dec 18, 2024

An index.d.ts file should be created in the root of the repository, which describes the extensions's JavaScript API using the TypeScript declaration file format.

Background

The k6lint and k6-extension-registry types checker checks if a TypeScript API declaration file (index.d.ts) for the k6 JavaScript extension exists in the root of the repository.

If index.d.ts does not exist, the extension will receive a lower grade. In this case:

badge

See also:

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

No branches or pull requests

1 participant