Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Commit b6e0093

Browse files
committed
docs(core): add documentation for adapter options
1 parent 7619031 commit b6e0093

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

packages/fury/lib/fury.js

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ const findAdapter = (adapters, mediaType, method) => {
3636
* @memberof FuryAdapter
3737
*/
3838

39+
/**
40+
* Adapter Options
41+
* @typedef {Object} AdapterOptions
42+
* @property {boolean} generateSourceMap
43+
* @property {boolean} generateMessageBody
44+
* @property {boolean} generateMessageBodySchema
45+
*/
46+
3947
/**
4048
* @function validate
4149
*
@@ -133,7 +141,7 @@ class Fury {
133141
* @param {Object} options
134142
* @param {string} options.source
135143
* @param {string} [options.mediaType]
136-
* @param {Object} [options.adapterOptions]
144+
* @param {AdapterOptions} [options.adapterOptions]
137145
* @param callback {ParseCallback}
138146
*/
139147
validate({ source, mediaType, adapterOptions }, done) {
@@ -192,7 +200,7 @@ class Fury {
192200
* @param {Object} options
193201
* @param {string} options.source
194202
* @param {string} [options.mediaType]
195-
* @param {Object} [options.adapterOptions]
203+
* @param {AdapterOptions} [options.adapterOptions]
196204
* @param callback {ParseCallback}
197205
*/
198206
parse({

0 commit comments

Comments
 (0)