Skip to content

Commit 8a956fa

Browse files
committed
chore: fixed lint failures
1 parent bbf139e commit 8a956fa

File tree

4 files changed

+17452
-90
lines changed

4 files changed

+17452
-90
lines changed

lib/index.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ module.exports = SwaggerParser;
1717
* This class parses a Swagger 2.0 or 3.0 API, resolves its JSON references and their resolved values,
1818
* and provides methods for traversing, dereferencing, and validating the API.
1919
*
20-
* @constructor
21-
* @extends $RefParser
20+
* @class
21+
* @augments $RefParser
2222
*/
2323
function SwaggerParser () {
2424
$RefParser.apply(this, arguments);
@@ -49,7 +49,7 @@ Object.defineProperty(SwaggerParser.prototype, "api", {
4949
* @param {string} [path] - The file path or URL of the JSON schema
5050
* @param {object} [api] - The Swagger API object. This object will be used instead of reading from `path`.
5151
* @param {ParserOptions} [options] - Options that determine how the API is parsed
52-
* @param {function} [callback] - An error-first callback. The second parameter is the parsed API object.
52+
* @param {Function} [callback] - An error-first callback. The second parameter is the parsed API object.
5353
* @returns {Promise} - The returned promise resolves with the parsed API object.
5454
*/
5555
SwaggerParser.prototype.parse = async function (path, api, options, callback) {
@@ -114,7 +114,7 @@ SwaggerParser.prototype.parse = async function (path, api, options, callback) {
114114
* @param {string} [path] - The file path or URL of the JSON schema
115115
* @param {object} [api] - The Swagger API object. This object will be used instead of reading from `path`.
116116
* @param {ParserOptions} [options] - Options that determine how the API is parsed, dereferenced, and validated
117-
* @param {function} [callback] - An error-first callback. The second parameter is the parsed API object.
117+
* @param {Function} [callback] - An error-first callback. The second parameter is the parsed API object.
118118
* @returns {Promise} - The returned promise resolves with the parsed API object.
119119
*/
120120
SwaggerParser.validate = function (path, api, options, callback) {
@@ -130,7 +130,7 @@ SwaggerParser.validate = function (path, api, options, callback) {
130130
* @param {string} [path] - The file path or URL of the JSON schema
131131
* @param {object} [api] - The Swagger API object. This object will be used instead of reading from `path`.
132132
* @param {ParserOptions} [options] - Options that determine how the API is parsed, dereferenced, and validated
133-
* @param {function} [callback] - An error-first callback. The second parameter is the parsed API object.
133+
* @param {Function} [callback] - An error-first callback. The second parameter is the parsed API object.
134134
* @returns {Promise} - The returned promise resolves with the parsed API object.
135135
*/
136136
SwaggerParser.prototype.validate = async function (path, api, options, callback) {

lib/options.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ module.exports = ParserOptions;
1111
* Options that determine how Swagger APIs are parsed, resolved, dereferenced, and validated.
1212
*
1313
* @param {object|ParserOptions} [_options] - Overridden options
14-
* @constructor
15-
* @extends $RefParserOptions
14+
* @class
15+
* @augments $RefParserOptions
1616
*/
1717
function ParserOptions (_options) {
1818
$RefParserOptions.call(this, ParserOptions.defaults);

0 commit comments

Comments
 (0)