Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 0 additions & 48 deletions apps/generator/docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ Use name of returned templates as input for the <code>generate</code> method for
* [.executeAfterHook()](#Generator+executeAfterHook) ⇒ `Promise.<void>`
* [.parseInput()](#Generator+parseInput)
* [.configureTemplate()](#Generator+configureTemplate)
* ~~[.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)
Expand Down Expand Up @@ -371,53 +370,6 @@ Configure the templates based the desired renderer.

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

<a name="Generator+generateFromString"></a>

### ~~generator.generateFromString~~
***Deprecated***

Generates files from a given template and AsyncAPI string.

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

- asyncapiString `String` - AsyncAPI string to use as source.
- [parseOptions] `Object` ` = {}` - AsyncAPI Parser parse options. Check out [@asyncapi/parser](https://www.github.com/asyncapi/parser-js) for more information.

**Example**
```js
const asyncapiString = `
asyncapi: '2.0.0'
info:
title: Example
version: 1.0.0
...
`;
generator
.generateFromString(asyncapiString)
.then(() => {
console.log('Done!');
})
.catch(console.error);
```
**Example** *(Using async/await)*
```js
const asyncapiString = `
asyncapi: '2.0.0'
info:
title: Example
version: 1.0.0
...
`;

try {
await generator.generateFromString(asyncapiString);
console.log('Done!');
} catch (e) {
console.error(e);
}
```

<a name="Generator+generateFromURL"></a>

### generator.generateFromURL
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{#unless deprecated~}}
{{string-repeat " " (add level baseLevel)}}* {{#unless (equal _title undefined)}}_{{_title}}_{{else}}{{>sig-link}}{{/unless}}
{{#groupBy (option "group-by")~}}
{{>member-index-grouped baseLevel=(add ../level ../baseLevel 1)~}}
{{/groupBy~}}
{{/unless~}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{#unless deprecated~}}
{{>index-indent}}* {{>sig-link-parent}}
{{#indexChildren ~}}
{{>member-index-list~}}
{{/indexChildren}}
{{/unless~}}
1 change: 1 addition & 0 deletions apps/generator/docs/jsdoc2md-handlebars/members.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{#children inherited=undefined ~}}{{#unless deprecated~}}{{>docs~}}{{/unless~}}{{/children~}}
2 changes: 1 addition & 1 deletion apps/generator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"test:integration": "npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
"test:integration:update": "npm run test:integration -- -u",
"test:cleanup": "rimraf \"test/temp\"",
"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",
"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",
"docker:build": "docker build -t asyncapi/generator:latest .",
"lint": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .",
"lint:fix": "npm run lint -- --fix",
Expand Down
Loading