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 default option values to api reference #902

Closed
gWOLF3 opened this issue Dec 1, 2021 · 2 comments
Closed

add default option values to api reference #902

gWOLF3 opened this issue Dec 1, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@gWOLF3
Copy link

gWOLF3 commented Dec 1, 2021

would be very helpful to be able to see the default values listed in the API reference documentation:

for example:
https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.jobsoptions.md

@manast
Copy link
Contributor

manast commented Dec 1, 2021

This seems to be possible to do with api-extractor, so i will mark this as an enhancement: https://api-extractor.com/pages/tsdoc/tag_defaultvalue/

@manast manast added the enhancement New feature or request label Dec 1, 2021
@roggervalf
Copy link
Collaborator

Our new api documentation is showing the defaultValue param https://api.docs.bullmq.io/interfaces/JobsOptions.html, please @gWOLF3 take a look when have some chance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants