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.

Sign up for GitHub

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

Jump to bottom

Only bundle function should be exposed as part of public API #70

Closed
derberg opened this issue Oct 10, 2022 · 3 comments · Fixed by #72
Closed

Only bundle function should be exposed as part of public API #70

derberg opened this issue Oct 10, 2022 · 3 comments · Fixed by #72
Labels
area/typescript Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. bug Something isn't working good first issue Good for newcomers

Comments

@derberg
Copy link
Member

derberg commented Oct 10, 2022

Describe the bug

When you go to https://github.com/asyncapi/bundler/blob/master/API.md#functions you see some internal functions in the API that users can use. But we should expose only bundle

Expected behavior

All functions other than bundle should be annotated as private, so they do not show up in the API
@derberg derberg added the bug Something isn't working label Oct 10, 2022
@derberg
Copy link
Member Author

derberg commented Oct 10, 2022

/gfi ts

@asyncapi-bot asyncapi-bot added area/typescript Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. good first issue Good for newcomers labels Oct 10, 2022
@toukirkhan
Copy link
Contributor

@derberg only the function sections needs to be annotated right?

aeworxet added a commit to aeworxet/asyncapi-bundler that referenced this issue Oct 11, 2022
@aeworxet @derberg
fix: added JSDoc annotations '@Private' (asyncapi#70)
4844a7e 
Co-authored-by: Lukasz Gornicki <[email protected]>
@derberg
Copy link
Member Author

derberg commented Oct 11, 2022

Afaik @aeworxet is working on this one already.
I can mark asyncapi/generator#538 if you want, pretty nifty and super useful feature to add

@aeworxet aeworxet mentioned this issue Oct 11, 2022
Merged
asyncapi-bot pushed a commit that referenced this issue Oct 11, 2022
@aeworxet
fix: add JSDoc annotations '@Private' (#70) (#72)
9d71de3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/typescript Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. bug Something isn't working good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: add JSDoc annotations '@private' (#70) aeworxet/asyncapi-bundler
3 participants
@derberg @asyncapi-bot @toukirkhan