Skip to content

Commit

Permalink
chore: update generated docs (#541)
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot authored Apr 29, 2022
1 parent ede66d0 commit b382043
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -3742,7 +3742,7 @@ Parses and validate an AsyncAPI document from YAML or JSON.
| Param | Type | Description |
| --- | --- | --- |
| asyncapiYAMLorJSON | <code>String</code> \| <code>Object</code> | An AsyncAPI document in JSON or YAML format. |
| [options] | <code>ParserOptions</code> | Configuration options object [ParserOptions](ParserOptions) |
| [options] | <code>ParserOptions</code> | Configuration options object [ParserOptions](#asyncapiparserparseroptions--object) |

<a name="module_@asyncapi/parser..parseFromUrl"></a>

Expand All @@ -3756,7 +3756,7 @@ Fetches an AsyncAPI document from the given URL and passes its content to the `p
| --- | --- | --- |
| url | <code>String</code> | URL where the AsyncAPI document is located. |
| [fetchOptions] | <code>Object</code> | Configuration to pass to the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Request) call. |
| [options] | <code>ParserOptions</code> | Configuration to pass to the [ParserOptions](ParserOptions) method. |
| [options] | <code>ParserOptions</code> | Configuration to pass to the [ParserOptions](#asyncapiparserparseroptions--object) method. |

<a name="module_@asyncapi/parser..registerSchemaParser"></a>

Expand All @@ -3780,8 +3780,8 @@ The complete list of parse configuration options used to parse the given data.
| Name | Type | Description |
| --- | --- | --- |
| [path] | <code>String</code> | Path to the AsyncAPI document. It will be used to resolve relative references. Defaults to current working dir. |
| [parse] | <code>Object</code> | Options object to pass to [json-schema-ref-parser](https://apidevtools.org/json-schema-ref-parser/docs/options.html). |
| [resolve] | <code>Object</code> | Options object to pass to [json-schema-ref-parser](https://apidevtools.org/json-schema-ref-parser/docs/options.html). |
| [parse] | <code>Object</code> | Options object to pass to [json-schema-ref-parser](https://apitools.dev/json-schema-ref-parser/docs/options.html). |
| [resolve] | <code>Object</code> | Options object to pass to [json-schema-ref-parser](https://apitools.dev/json-schema-ref-parser/docs/options.html). |
| [applyTraits] | <code>Boolean</code> | Whether to resolve and apply traits or not. Defaults to true. |

<a name="MixinBindings"></a>
Expand Down
2 changes: 1 addition & 1 deletion dist/bundle.js

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1173,8 +1173,8 @@ declare module "@asyncapi/parser" {
/**
* The complete list of parse configuration options used to parse the given data.
* @property [path] - Path to the AsyncAPI document. It will be used to resolve relative references. Defaults to current working dir.
* @property [parse] - Options object to pass to {@link https://apidevtools.org/json-schema-ref-parser/docs/options.html|json-schema-ref-parser}.
* @property [resolve] - Options object to pass to {@link https://apidevtools.org/json-schema-ref-parser/docs/options.html|json-schema-ref-parser}.
* @property [parse] - Options object to pass to {@link https://apitools.dev/json-schema-ref-parser/docs/options.html|json-schema-ref-parser}.
* @property [resolve] - Options object to pass to {@link https://apitools.dev/json-schema-ref-parser/docs/options.html|json-schema-ref-parser}.
* @property [applyTraits] - Whether to resolve and apply traits or not. Defaults to true.
*/
type ParserOptions = {
Expand All @@ -1186,15 +1186,15 @@ declare module "@asyncapi/parser" {
/**
* Parses and validate an AsyncAPI document from YAML or JSON.
* @param asyncapiYAMLorJSON - An AsyncAPI document in JSON or YAML format.
* @param [options] - Configuration options object {@link ParserOptions}
* @param [options] - Configuration options object {@link #asyncapiparserparseroptions--object|ParserOptions}
* @returns The parsed AsyncAPI document.
*/
function parse(asyncapiYAMLorJSON: string | any, options?: ParserOptions): Promise<AsyncAPIDocument>;
/**
* Fetches an AsyncAPI document from the given URL and passes its content to the `parse` method.
* @param url - URL where the AsyncAPI document is located.
* @param [fetchOptions] - Configuration to pass to the {@link https://developer.mozilla.org/en-US/docs/Web/API/Request|fetch} call.
* @param [options] - Configuration to pass to the {@link ParserOptions} method.
* @param [options] - Configuration to pass to the {@link #asyncapiparserparseroptions--object|ParserOptions} method.
* @returns The parsed AsyncAPI document.
*/
function parseFromUrl(url: string, fetchOptions?: any, options?: ParserOptions): Promise<AsyncAPIDocument>;
Expand Down

0 comments on commit b382043

Please sign in to comment.