enhancement: reduce errors generated from JSDoc expectations

Author: igneel64

lib/JSONAPISerializer.js

@@ -36,7 +36,7 @@ module.exports = class JSONAPISerializer {
    *
    * @method JSONAPISerializer#register
    * @param {string} type resource's type.
-   * @param {string} [schema=default] schema name.
+   * @param {string|Object} [schema='default'] schema name.
    * @param {Object} [options] options.
    */
   register(type, schema, options) {
@@ -60,7 +60,7 @@ module.exports = class JSONAPISerializer {
    * @method JSONAPISerializer#serialize
    * @param {string|Object} type resource's type as string or a dynamic type options as object.
    * @param {Object|Object[]} data input data.
-   * @param {string} [schema=default] resource's schema name.
+   * @param {string|Object} [schema='default'] resource's schema name.
    * @param {Object} [extraData] additional data that can be used in topLevelMeta options.
    * @return {Object} serialized data.
    */
@@ -115,7 +115,7 @@ module.exports = class JSONAPISerializer {
    * @method JSONAPISerializer#serializeAsync
    * @param {string} type resource's type.
    * @param {Object|Object[]} data input data.
-   * @param {string} [schema=default] resource's schema name.
+   * @param {string} [schema='default'] resource's schema name.
    * @param {Object} [extraData] additional data that can be used in topLevelMeta options.
    * @return {Promise} resolves with serialized data.
    */
@@ -333,7 +333,7 @@ module.exports = class JSONAPISerializer {
    * @param {string|Object} type resource's type as string or an object with a dynamic type resolved from data.
    * @param {Object} data JSON API resource data.
    * @param {string} [schema=default] resource's schema name.
-   * @param {Map<string:Object>} included.
+   * @param {Map<string, Object>} included Included resources.
    * @return {Object} deserialized data.
    */
   deserializeResource(type, data, schema, included) {
@@ -465,8 +465,8 @@ module.exports = class JSONAPISerializer {
    * @private
    * @param {string} type resource's type.
    * @param {Object|Object[]} data input data.
-   * @param {options} options resource's configuration options.
-   * @param {Map<string:Object>} included.
+   * @param {Object} options resource's configuration options.
+   * @param {Map<string, Object>} included Included resources.
    * @param {Object} extraData additional data.
    * @return {Object|Object[]} serialized data.
    */
@@ -498,7 +498,7 @@ module.exports = class JSONAPISerializer {
    * @private
    * @param {Object} typeOption a dynamic type options.
    * @param {Object|Object[]} data input data.
-   * @param {Map<string:Object>} included.
+   * @param {Map<string, Object>} included Included resources.
    * @param {Object} extraData additional data.
    * @return {Object|Object[]} serialized data.
    */
@@ -574,7 +574,7 @@ module.exports = class JSONAPISerializer {
    * @private
    * @param {Object|Object[]} data input data.
    * @param {Object} options resource's configuration options.
-   * @param {Map<string:Object>} included.
+   * @param {Map<string, Object>} included  Included resources.
    * @param {Object} extraData additional data.
    * @return {Object} serialized relationships.
    */
@@ -634,8 +634,8 @@ module.exports = class JSONAPISerializer {
    * @param {string|Function} rType the relationship's type.
    * @param {string} rSchema the relationship's schema
    * @param {Object|Object[]} rData relationship's data.
-   * @param {Map<string:Object>} included.
-   * @param {Object} the entire resource's data.
+   * @param {Map<string, Object>} included Included resources.
+   * @param {Object} data the entire resource's data.
    * @param {Object} extraData additional data.
    * @return {Object|Object[]} serialized relationship data.
    */
@@ -700,7 +700,7 @@ module.exports = class JSONAPISerializer {
    * @param {Object} data data passed to functions options
    * @param {Object} extraData additional data passed to functions options
    * @param {Object} options configuration options.
-   * @param {string} fallbackModeIfOneArg fallback mode if only one argument is passed to function.
+   * @param {string} [fallbackModeIfOneArg] fallback mode if only one argument is passed to function.
    * Avoid breaking changes with issue https://github.com/danivek/json-api-serializer/issues/27.
    * @return {Object}
    */