Skip to content

Commit

Permalink
chore(release): v1.13.0 (#1041)
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot authored Sep 28, 2023
1 parent 553b5e2 commit a6f9eca
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 1,141 deletions.
27 changes: 15 additions & 12 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Reference API documentation for AsyncAPI Generator library.
* [.hooks](#Generator+hooks) : `Object`
* [.mapBaseUrlToFolder](#Generator+mapBaseUrlToFolder) : `Object`
* [.templateParams](#Generator+templateParams) : `Object`
* [.originalAsyncAPI](#Generator+originalAsyncAPI) : `String`
* [.generate(asyncapiDocument)](#Generator+generate)`Promise`
* [.generate(asyncapiDocument, [parseOptions])](#Generator+generate)`Promise`
* [.parseInput()](#Generator+parseInput)
* [.configureTemplate()](#Generator+configureTemplate)
* [.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString)`Promise`
* ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString)`Promise`~~
* [.generateFromURL(asyncapiURL)](#Generator+generateFromURL)`Promise`
* [.generateFromFile(asyncapiFile)](#Generator+generateFromFile)`Promise`
* [.installTemplate([force])](#Generator+installTemplate)
Expand Down Expand Up @@ -163,13 +163,6 @@ The template parameters. The structure for this object is based on each individu

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

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

* generator.originalAsyncAPI : `String`** :
AsyncAPI string to use as a source.

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

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

### generator.generate
Expand All @@ -178,7 +171,8 @@ Generates files from a given template and an AsyncAPIDocument object.
**Kind**: instance method of [`Generator`](#Generator)
**Params**

- asyncapiDocument `AsyncAPIDocument` - AsyncAPIDocument object to use as source.
- asyncapiDocument `AsyncAPIDocument` | `string` - AsyncAPIDocument object to use as source.
- [parseOptions] `Object` ` = {}` - AsyncAPI Parser parse options. Check out [@asyncapi/parser](https://www.github.com/asyncapi/parser-js) for more information. Remember to use the right options to the right parser depending on the template you are using.

**Example**
```js
Expand All @@ -199,6 +193,13 @@ try {
}
```

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

* generator.parseInput()** :
Parse the generator input based on the template `templateConfig.apiVersion` value.

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

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

* generator.configureTemplate()** :
Expand All @@ -208,7 +209,9 @@ Configure the templates based the desired renderer.

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

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

Generates files from a given template and AsyncAPI string.

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

0 comments on commit a6f9eca

Please sign in to comment.