chore: fix warnings

Author: jonastg

API.md

@@ -15,7 +15,7 @@ const buildError = (from, to) => {
  * Represents an error while trying to parse an AsyncAPI document.
  * 
  * @alias module:@asyncapi/parser#ParserError
- * @extends Error
+ * @augments Error
  */
 class ParserError extends Error {
   /**
@@ -56,7 +56,7 @@ class ParserError extends Error {
   }
 
   /**
-   * Returns a JS object representation of the error.
+   * @returns {object} Returns a JS object representation of the error.
    */
   toJS() {
     return buildError(this, {});

dist/bundle.js

@@ -37,7 +37,7 @@ const MixinBindings = {
 
   /**
    * @param {string} name - Name of the binding.
-   * @returns {(Object | null)}
+   * @returns {(object | null)}
    */
   binding(name) {
     return getMapValueByKey(this._json.bindings, name);

lib/errors/parser-error.js

@@ -39,64 +39,64 @@ class AsyncAPIDocument extends Base {
   }
 
   /**
-   * @returns {string}
+   * @returns {string} Version.
    */
   version() {
     return this._json.asyncapi;
   }
 
   /**
-   * @returns {Info}
+   * @returns {Info} Info.
    */
   info() {
     return new Info(this._json.info);
   }
 
   /**
-   * @returns {string}
+   * @returns {string} Id.
    */
   id() {
     return this._json.id;
   }
 
   /**
-   * @returns {boolean}
+   * @returns {boolean} If it has servers.
    */
   hasServers() {
     return !!this._json.servers;
   }
 
   /**
-   * @returns {object<string, Server>}
+   * @returns {object<string, Server>} Servers.
    */
   servers() {
     return createMapOfType(this._json.servers, Server);
   }
 
   /**
    * @param {string} name - Name of the server.
-   * @returns {Server}
+   * @returns {Server} The server for given name.
    */
   server(name) {
     return getMapValueOfType(this._json.servers, name, Server);
   }
 
   /**
-   * @returns {boolean}
+   * @returns {boolean} If it has channels.
    */
   hasChannels() {
     return !!this._json.channels;
   }
 
   /**
-   * @returns {object<string, Channel>}
+   * @returns {object<string, Channel>} Channels.
    */
   channels() {
     return createMapOfType(this._json.channels, Channel, this);
   }
 
   /**
-   * @returns {string[]}
+   * @returns {string[]} An array with channels names.
    */
   channelNames() {
     if (!this._json.channels) return [];
@@ -105,43 +105,43 @@ class AsyncAPIDocument extends Base {
 
   /**
    * @param {string} name - Name of the channel.
-   * @returns {Channel}
+   * @returns {Channel} The channel for given name.
    */
   channel(name) {
     return getMapValueOfType(this._json.channels, name, Channel, this);
   }
 
   /**
-   * @returns {string}
+   * @returns {string} The content type.
    */
   defaultContentType() {
     return this._json.defaultContentType || null;
   }
 
   /**
-   * @returns {boolean}
+   * @returns {boolean} If it has Components.
    */
   hasComponents() {
     return !!this._json.components;
   }
 
   /**
-   * @returns {Components}
+   * @returns {Components} Components
    */
   components() {
     if (!this._json.components) return null;
     return new Components(this._json.components);
   }
 
   /**
-   * @returns {boolean}
+   * @returns {boolean} If it has messages.
    */
   hasMessages() {
     return !!this.allMessages().size;
   }
 
   /**
-   * @returns {Map<string, Message>}
+   * @returns {Map<string, Message>} All messages.
    */
   allMessages() {
     const messages = new Map();
@@ -172,7 +172,7 @@ class AsyncAPIDocument extends Base {
   }
 
   /**
-   * @returns {Map<string, Schema>}
+   * @returns {Map<string, Schema>} All schemas.
    */
   allSchemas() {
     const schemas = new Map();
@@ -192,7 +192,7 @@ class AsyncAPIDocument extends Base {
   }
 
   /**
-   * @returns {boolean}
+   * @returns {boolean} If it has circular refs.
    */
   hasCircular() {
     return !!this._json[String(xParserCircle)];
@@ -203,7 +203,7 @@ class AsyncAPIDocument extends Base {
  * Assign message keys as message name to all the component messages.
  * 
  * @private
- * @param {AsyncAPIDocument} doc 
+ * @param {AsyncAPIDocument} doc Document.
  */
 function assignNameToComponentMessages(doc) {
   if (doc.hasComponents()) {
@@ -219,7 +219,7 @@ function assignNameToComponentMessages(doc) {
  * Assign parameter keys as uid for the parameter schema.
  * 
  * @private
- * @param {AsyncAPIDocument} doc 
+ * @param {AsyncAPIDocument} doc Document.
  */
 function assignUidToParameterSchemas(doc) {
   doc.channelNames().forEach(channelName => {
@@ -234,7 +234,7 @@ function assignUidToParameterSchemas(doc) {
  * Assign uid to component schemas. 
  * 
  * @private
- * @param {AsyncAPIDocument} doc 
+ * @param {AsyncAPIDocument} doc Document.
  */
 function assignUidToComponentSchemas(doc) {
   if (doc.hasComponents()) {
@@ -248,7 +248,7 @@ function assignUidToComponentSchemas(doc) {
  * Assign anonymous names to nameless messages.
  * 
  * @private
- * @param {AsyncAPIDocument} doc 
+ * @param {AsyncAPIDocument} doc Document.
  */
 function assignNameToAnonymousMessages(doc) {
   let anonymousMessageCounter = 0;
@@ -264,9 +264,11 @@ function assignNameToAnonymousMessages(doc) {
 
 /**
  * Add anonymous name to key if no name provided.
- * 
+ *
  * @private
- * @param {Message} map of messages 
+ * @param messages
+ * @param number
+ * @param {Message} map of messages
  */
 function addNameToKey(messages, number) {
   messages.forEach(m => {
@@ -278,18 +280,21 @@ function addNameToKey(messages, number) {
 
 /**
  * Function that indicates that a circular reference was detected.
+ *
  * @private
  * @param {Schema} schema schema that is currently accessed and need to be checked if it is a first time
  * @param {Array} seenObjects list of objects that were already seen during recursion 
+ * @returns {boolean} If has circular references or not.
  */
 function isCircular(schema, seenObjects) {
   return seenObjects.includes(schema.json());
 }
 
 /**
  * Mark schema as being a circular ref
- * 
+ *
  * @private
+ * @param prop
  * @param {Schema} schema schema that should be marked as circular
  */
 function markCircular(schema, prop) {
@@ -302,15 +307,17 @@ function markCircular(schema, prop) {
 
 /**
  * Callback that is called foreach schema found
+ *
  * @private
  * @callback FoundSchemaCallback
  * @param {Schema} schema found.
-*/
+ */
 /**
  * Recursively go through each schema and execute callback.
- * 
+ *
  * @private
  * @param {Schema} schema found.
+ * @param schemaContent
  * @param {FoundSchemaCallback} callback
  */
 function recursiveSchema(schemaContent, callback) {
@@ -322,13 +329,15 @@ function recursiveSchema(schemaContent, callback) {
 
 /**
  * Schema crawler
- * 
+ *
  * @private
  * @param {Schema} schemaContent schema.
+ * @param schema
  * @param {Array} seenObj schema elements that crowler went through already.
- * @param {Function} callback(schema)
- *         the function that is called foreach schema found.
- *         schema {Schema}: the found schema.
+ * @param callback
+ * @param {Function} callback(schema) 
+ * the function that is called foreach schema found.
+ * schema {Schema}: the found schema.
  */
 function crawl(schema, seenObj, callback) {
   if (isCircular(schema, seenObj)) return true;
@@ -411,13 +420,14 @@ function assignIdToAnonymousSchemas(doc) {
 
 /**
  * Recursively go through schema of object type and execute callback.
- * 
+ *
  * @private
  * @param {Schema} schema Object type.
  * @param {Array} seenObj schema elements that crawler went through already.
- * @param {Function} callback(schema)
- *         the function that is called foreach schema found.
- *         schema {Schema}: the found schema.
+ * @param callback
+ * @param {Function} callback(schema) 
+ * the function that is called foreach schema found.
+ * schema {Schema}: the found schema.
  */
 function recursiveSchemaObject(schema, seenObj, callback) {
   if (schema.additionalProperties() !== undefined && typeof schema.additionalProperties() !== 'boolean') {
@@ -434,13 +444,14 @@ function recursiveSchemaObject(schema, seenObj, callback) {
 
 /**
  * Recursively go through schema of array type and execute callback.
- * 
+ *
  * @private
  * @param {Schema} schema Array type.
  * @param {Array} seenObj schema elements that crowler went through already.
- * @param {Function} callback(schema)
- *         the function that is called foreach schema found.
- *         schema {Schema}: the found schema.
+ * @param callback
+ * @param {Function} callback(schema) 
+ * the function that is called foreach schema found.
+ * schema {Schema}: the found schema.
  */
 function recursiveSchemaArray(schema, seenObj, callback) {
   if (schema.additionalItems() !== undefined) {

lib/mixins/bindings.js

@@ -5,7 +5,7 @@ const ParserError = require('../errors/parser-error');
  * 
  * @class
  * @alias module:@asyncapi/parser#Base
- * @returns {Base}
+ * @returns {Base} 
  */
 class Base {
   constructor (json) {
@@ -14,7 +14,8 @@ class Base {
   }
 
   /**
-   * @returns {any}
+   * @param {any} key Key to find
+   * @returns {any} The value for the given key
    */
   json(key) {
     if (key === undefined) return this._json;

lib/models/asyncapi.js

@@ -11,7 +11,7 @@ const MixinSpecificationExtensions = require('../mixins/specification-extensions
  * 
  * @class
  * @alias module:@asyncapi/parser#ChannelParameter
- * @extends Base
+ * @augments Base
  * @mixes MixinDescription
  * @mixes MixinSpecificationExtensions
  * @returns {ChannelParameter}

lib/models/base.js

@@ -14,7 +14,7 @@ const MixinSpecificationExtensions = require('../mixins/specification-extensions
  * 
  * @class
  * @alias module:@asyncapi/parser#Channel
- * @extends Base
+ * @augments Base
  * @mixes MixinDescription
  * @mixes MixinBindings
  * @mixes MixinSpecificationExtensions