Skip to content

Commit

Permalink
chore(release): v1.17.0 (#1103)
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot authored Jan 18, 2024
1 parent b5ff633 commit 6ed52b4
Show file tree
Hide file tree
Showing 3 changed files with 155 additions and 46 deletions.
12 changes: 12 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Reference API documentation for AsyncAPI Generator library.
* [Generator](#Generator)
* [new Generator(templateName, targetDir, options)](#new_Generator_new)
* _instance_
* [.registry](#Generator+registry) : `Object`
* [.templateName](#Generator+templateName) : `String`
* [.targetDir](#Generator+targetDir) : `String`
* [.entrypoint](#Generator+entrypoint) : `String`
Expand Down Expand Up @@ -64,6 +65,10 @@ Instantiates a new Generator object.
- [.install] `Boolean` ` = false` - Install the template and its dependencies, even when the template has already been installed.
- [.debug] `Boolean` ` = false` - Enable more specific errors in the console. At the moment it only shows specific errors about filters. Keep in mind that as a result errors about template are less descriptive.
- [.mapBaseUrlToFolder] `Object.<String, String>` - Optional parameter to map schema references from a base url to a local base folder e.g. url=https://schema.example.com/crm/ folder=./test/docs/ .
- [.registry] `Object` - Optional parameter with private registry configuration
- [.url] `String` - Parameter to pass npm registry url
- [.auth] `String` - Optional parameter to pass npm registry username and password encoded with base64, formatted like username:password value should be encoded
- [.token] `String` - Optional parameter to pass npm registry auth token that you can grab from .npmrc file

**Example**
```js
Expand All @@ -80,6 +85,13 @@ const generator = new Generator('@asyncapi/html-template', path.resolve(__dirnam
});
```

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

* generator.registry : `Object`** :
Npm registry information.

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

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

* generator.templateName : `String`** :
Expand Down
187 changes: 142 additions & 45 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@asyncapi/generator",
"version": "1.16.0",
"version": "1.17.0",
"description": "The AsyncAPI generator. It can generate documentation, code, anything!",
"main": "./lib/generator.js",
"bin": {
Expand Down

0 comments on commit 6ed52b4

Please sign in to comment.