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

fix: add param names to jsdocs, remove types separation #124

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

KuNman
Copy link

@KuNman KuNman commented Dec 7, 2023

Hey,
while we tried to use this library discovered that there are small issues with type declarations:

  1. Few typescript types miss names for variables as they are missing in jsdocs.
  2. We couldn't use library as typescript types were exported to separate directory, while usually they are alongside source code (commonJS).

PR fixes both issues.

"description": "A JavaScript package to calculate thermophysiological, thermal comfort, thermal stress indices",
"type": "module",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is needed for ES6 modules (importing modules with the modern syntax import ... from. Are we sure we want to revert to CommonJS (commonJS is not supported in browsers and is generally considered that new projects should use ES6)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me verify is it still needed.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@szaldivar yes, we still need it to use with import {} from....

@szaldivar
Copy link
Collaborator

Hey, while we tried to use this library discovered that there are small issues with type declarations:

1. Few typescript types miss names for variables as they are missing in jsdocs.

2. We couldn't use library as typescript types were exported to separate directory, while usually they are alongside source code (commonJS).

PR fixes both issues.

What did you run into when using the library?

@KuNman
Copy link
Author

KuNman commented Dec 12, 2023

Hey, while we tried to use this library discovered that there are small issues with type declarations:

1. Few typescript types miss names for variables as they are missing in jsdocs.

2. We couldn't use library as typescript types were exported to separate directory, while usually they are alongside source code (commonJS).

PR fixes both issues.

What did you run into when using the library?

We are using it for node backend with nestjs.

@FedericoTartarini
Copy link
Owner

Thank you @szaldivar for commenting and reviewing the Pull request. I will leave it with you since you have a deeper understanding of the topic.

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