docs(core): add documentation for adapter options

apiaryio · Apr 17, 2020 · d25b510 · d25b510
1 parent eaaa134
commit d25b510
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/packages/fury/lib/fury.js b/packages/fury/lib/fury.js
@@ -36,6 +36,14 @@ const findAdapter = (adapters, mediaType, method) => {
  * @memberof FuryAdapter
  */
 
+/**
+ * Adapter Options
+ * @typedef {Object} AdapterOptions
+ * @property {boolean} generateSourceMap
+ * @property {boolean} generateMessageBody
+ * @property {boolean} generateMessageBodySchema
+ */
+
 /**
  * @function validate
  *
@@ -133,7 +141,7 @@ class Fury {
    * @param {Object} options
    * @param {string} options.source
    * @param {string} [options.mediaType]
-   * @param {Object} [options.adapterOptions]
+   * @param {AdapterOptions} [options.adapterOptions]
    * @param callback {ParseCallback}
    */
   validate({ source, mediaType, adapterOptions }, done) {
@@ -192,7 +200,7 @@ class Fury {
    * @param {Object} options
    * @param {string} options.source
    * @param {string} [options.mediaType]
-   * @param {Object} [options.adapterOptions]
+   * @param {AdapterOptions} [options.adapterOptions]
    * @param callback {ParseCallback}
    */
   parse({