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

docs: jsdoc return statement update #1330

Merged
merged 1 commit into from
Jan 14, 2025
Merged

docs: jsdoc return statement update #1330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions apps/generator/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ Reference API documentation for AsyncAPI Generator library.
* [.executeAfterHook()](#Generator+executeAfterHook) ⇒ `Promise.<void>`
* [.parseInput()](#Generator+parseInput)
* [.configureTemplate()](#Generator+configureTemplate)
* ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise`~~
* [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise`
* [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise`
* ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString) ⇒ `Promise.<(TemplateRenderResult|undefined)>`~~
* [.generateFromURL(asyncapiURL)](#Generator+generateFromURL) ⇒ `Promise.<(TemplateRenderResult|undefined)>`
* [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ `Promise.<(TemplateRenderResult|undefined)>`
* [.installTemplate([force])](#Generator+installTemplate)
* _static_
* [.getTemplateFile(templateName, filePath, [templatesDir])](#Generator.getTemplateFile) ⇒ `Promise`
Expand Down
6 changes: 3 additions & 3 deletions apps/generator/lib/generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ class Generator {
* @param {String} asyncapiString AsyncAPI string to use as source.
* @param {Object} [parseOptions={}] AsyncAPI Parser parse options. Check out {@link https://www.github.com/asyncapi/parser-js|@asyncapi/parser} for more information.
* @deprecated Use the `generate` function instead. Just change the function name and it works out of the box.
* @return {Promise}
* @return {Promise<TemplateRenderResult|undefined>}
*/
async generateFromString(asyncapiString, parseOptions = {}) {
const isParsableCompatible = asyncapiString && typeof asyncapiString === 'string';
Expand Down Expand Up @@ -466,7 +466,7 @@ class Generator {
* }
*
* @param {String} asyncapiURL Link to AsyncAPI file
* @return {Promise}
* @return {Promise<TemplateRenderResult|undefined>}
*/
async generateFromURL(asyncapiURL) {
const doc = await fetchSpec(asyncapiURL);
Expand All @@ -493,7 +493,7 @@ class Generator {
* }
*
* @param {String} asyncapiFile AsyncAPI file to use as source.
* @return {Promise}
* @return {Promise<TemplateRenderResult|undefined>}
*/
async generateFromFile(asyncapiFile) {
const doc = await readFile(asyncapiFile, { encoding: 'utf8' });
Expand Down
Loading