docs(merge-params): adds custom merge-params and merge-prop jsdoc #2131
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds custom tags to jsdoc that allow merging parameter and property definitions: `@merge-params`: used in place of a @param whose type is defined elsewhere. Will expand out all of the properties of the type. `@merge-props`: used in a typedef that inherits from another typedef. Will inherit all properties of that typedef.
mbroadst
approved these changes
Sep 17, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds custom tags to jsdoc that allow merging parameter and property
definitions:
@merge-params: used in place of a @param whose type is definedelsewhere. Will expand out all of the properties of the type.
@merge-props: used in a typedef that inherits from another typedef.Will inherit all properties of that typedef.
Example of
ChangeStreamnow:Example of
ChangeStreamusing@merge-paramsfor its options object:What changed?
conf.jsonAre there any files to ignore?
nope.