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 API docs with typedoc #87

Merged
merged 1 commit into from
Jun 12, 2022

Conversation

mostafa
Copy link
Owner

@mostafa mostafa commented Jun 12, 2022

This PR adds typedoc to generate the latest documentation of the types available and updated in index.d.ts.

@mostafa mostafa merged commit 1832099 into fix-sasl-and-tls-config Jun 12, 2022
@mostafa mostafa deleted the add-api-docs-with-typedoc branch June 12, 2022 16:33
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

mostafa added a commit that referenced this pull request Jun 13, 2022
* Fix SASL and TLS issues reported in #56 and #84
* Replace dead status code
* Fix error message
* Exclude gosec G402 error
* Update JS API docs
* Add API docs with typedoc (#87)
@mostafa
Copy link
Owner Author

mostafa commented Jun 20, 2022

Released in v0.11.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Release
Development

Successfully merging this pull request may close these issues.

1 participant