-
-
Notifications
You must be signed in to change notification settings - Fork 37
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
DOCS: add typehints #220
Labels
Milestone
Comments
jkowalleck
added a commit
that referenced
this issue
Jan 27, 2022
jkowalleck
added a commit
that referenced
this issue
Jan 28, 2022
jkowalleck
added a commit
that referenced
this issue
Jan 28, 2022
jkowalleck
added a commit
that referenced
this issue
Jan 28, 2022
jkowalleck
added a commit
that referenced
this issue
Jan 29, 2022
jkowalleck
added a commit
that referenced
this issue
Feb 2, 2022
…ormalize optional `version` (#247) * Changed * Private/protected properties of Component models are no longer directly accessible. ([#233] via [#247]) Access via public getter/setter. * Fixed * Normalization guarantees `component.version`. ([#248] via [#247]) * Component's constructor may detect & set `autor` based on package info. ([#246] via [#247]) * Added * JSDoc for Component model. ([#220] via [#247]) [#220]: #220 [#233]: #233 [#246]: #246 [#247]: #247 [#248]: #248 --- * Component rework detect component.author - fixes #246 normalize empty component.version - fixes #248 add JSDoc - #220 use private properties - #233 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> * use `@babel/eslint-parser` Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> * update locked dependencies and lockfile format Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> * CT/CI generates jsdoc & play with jsdoc Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> * wrote history Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> * slacked components getterusage internally Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com> * fixed JSDoc `object` annotation Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
current implementation is untyped undocumented javascript
as a user of this library i want type docs, so that i know expected parameter types.
as a user of this library i want type docs, so that i know possible throws.
as a user of this library i want type docs, so that i know possible return types.
as a user of this library i want type docs, so that tools/IDE assistance is improved.
options:
*.d.ts
) to the projectenforce typehints via eslint rules: https://github.com/gajus/eslint-plugin-jsdoc
The text was updated successfully, but these errors were encountered: