Skip to content

Commit eb70bd9

Browse files
docs: remove deprecated methods from API docs (#1755)
Co-authored-by: kartikayy007 <kartikayy6969@gmail.com> Co-authored-by: Chan <bot+chan@asyncapi.io>
1 parent 863d80e commit eb70bd9

File tree

5 files changed

+14
-49
lines changed

5 files changed

+14
-49
lines changed

apps/generator/docs/api.md

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ Use name of returned templates as input for the <code>generate</code> method for
5454
* [.executeAfterHook()](#Generator+executeAfterHook)`Promise.<void>`
5555
* [.parseInput()](#Generator+parseInput)
5656
* [.configureTemplate()](#Generator+configureTemplate)
57-
* ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString)`Promise.<(TemplateRenderResult|undefined)>`~~
5857
* [.generateFromURL(asyncapiURL)](#Generator+generateFromURL)`Promise.<(TemplateRenderResult|undefined)>`
5958
* [.generateFromFile(asyncapiFile)](#Generator+generateFromFile)`Promise.<(TemplateRenderResult|undefined)>`
6059
* [.installTemplate([force])](#Generator+installTemplate)
@@ -371,53 +370,6 @@ Configure the templates based the desired renderer.
371370

372371
**Kind**: instance method of [`Generator`](#Generator)
373372

374-
<a name="Generator+generateFromString"></a>
375-
376-
### ~~generator.generateFromString~~
377-
***Deprecated***
378-
379-
Generates files from a given template and AsyncAPI string.
380-
381-
**Kind**: instance method of [`Generator`](#Generator)
382-
**Params**
383-
384-
- asyncapiString `String` - AsyncAPI string to use as source.
385-
- [parseOptions] `Object` ` = {}` - AsyncAPI Parser parse options. Check out [@asyncapi/parser](https://www.github.com/asyncapi/parser-js) for more information.
386-
387-
**Example**
388-
```js
389-
const asyncapiString = `
390-
asyncapi: '2.0.0'
391-
info:
392-
title: Example
393-
version: 1.0.0
394-
...
395-
`;
396-
generator
397-
.generateFromString(asyncapiString)
398-
.then(() => {
399-
console.log('Done!');
400-
})
401-
.catch(console.error);
402-
```
403-
**Example** *(Using async/await)*
404-
```js
405-
const asyncapiString = `
406-
asyncapi: '2.0.0'
407-
info:
408-
title: Example
409-
version: 1.0.0
410-
...
411-
`;
412-
413-
try {
414-
await generator.generateFromString(asyncapiString);
415-
console.log('Done!');
416-
} catch (e) {
417-
console.error(e);
418-
}
419-
```
420-
421373
<a name="Generator+generateFromURL"></a>
422374

423375
### generator.generateFromURL
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{{#unless deprecated~}}
2+
{{string-repeat " " (add level baseLevel)}}* {{#unless (equal _title undefined)}}_{{_title}}_{{else}}{{>sig-link}}{{/unless}}
3+
{{#groupBy (option "group-by")~}}
4+
{{>member-index-grouped baseLevel=(add ../level ../baseLevel 1)~}}
5+
{{/groupBy~}}
6+
{{/unless~}}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{{#unless deprecated~}}
2+
{{>index-indent}}* {{>sig-link-parent}}
3+
{{#indexChildren ~}}
4+
{{>member-index-list~}}
5+
{{/indexChildren}}
6+
{{/unless~}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{#children inherited=undefined ~}}{{#unless deprecated~}}{{>docs~}}{{/unless~}}{{/children~}}

apps/generator/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"test:integration": "npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
1919
"test:integration:update": "npm run test:integration -- -u",
2020
"test:cleanup": "rimraf \"test/temp\"",
21-
"docs": "jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/docs.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs --files lib/generator.js > docs/api.md",
21+
"docs": "jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs docs/jsdoc2md-handlebars/member-index-list.hbs docs/jsdoc2md-handlebars/member-index-grouped.hbs docs/jsdoc2md-handlebars/members.hbs --files lib/generator.js > docs/api.md",
2222
"docker:build": "docker build -t asyncapi/generator:latest .",
2323
"lint": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .",
2424
"lint:fix": "npm run lint -- --fix",

0 commit comments

Comments
 (0)