Skip to content

Commit d861164

Browse files
asyncapi-botasyncapi-botasyncapi-bot-eve
authored
docs(generator): update latest generator documentation (#4611)
Co-authored-by: asyncapi-bot <info@asyncapi.io> Co-authored-by: Eve <bot+eve@asyncapi.io>
1 parent 47a9d92 commit d861164

File tree

1 file changed

+0
-48
lines changed
  • markdown/docs/tools/generator

1 file changed

+0
-48
lines changed

markdown/docs/tools/generator/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

0 commit comments

Comments
 (0)