add specs for public functions

Surnet · Oct 20, 2020 · 2b7d6a8 · 2b7d6a8
1 parent 105f461
commit 2b7d6a8
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 9 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -1,11 +1,6 @@
 const { YAMLException } = require('js-yaml');
 const getSpecificationObject = require('./helpers/getSpecificationObject');
 
-const createSpecification = require('./helpers/createSpecification');
-const parseApiFileContent = require('./helpers/parseApiFileContent');
-const updateSpecificationObject = require('./helpers/updateSpecificationObject');
-const finalizeSpecificationObject = require('./helpers/finalizeSpecificationObject');
-
 /**
  * Generates the specification.
  * @param {object} options - Configuration options
@@ -40,7 +35,7 @@ module.exports = (options) => {
   }
 };
 
-module.exports.createSpecification = createSpecification;
-module.exports.parseApiFileContent = parseApiFileContent;
-module.exports.updateSpecificationObject = updateSpecificationObject;
-module.exports.finalizeSpecificationObject = finalizeSpecificationObject;
+module.exports.createSpecification = require('./helpers/createSpecification');
+module.exports.parseApiFileContent = require('./helpers/parseApiFileContent');
+module.exports.updateSpecificationObject = require('./helpers/updateSpecificationObject');
+module.exports.finalizeSpecificationObject = require('./helpers/finalizeSpecificationObject');
diff --git a/test/lib.spec.js b/test/lib.spec.js
@@ -3,6 +3,19 @@ const { YAMLException } = require('js-yaml');
 const swaggerJsdoc = require('../lib');
 
 describe('swagger-jsdoc library', () => {
+  describe('Public APIs', () => {
+    it('main module is a function', () => {
+      expect(typeof swaggerJsdoc).toBe('function');
+    });
+
+    it('should expose a few utilities', () => {
+      expect(typeof swaggerJsdoc.createSpecification).toBe('function');
+      expect(typeof swaggerJsdoc.parseApiFileContent).toBe('function');
+      expect(typeof swaggerJsdoc.updateSpecificationObject).toBe('function');
+      expect(typeof swaggerJsdoc.finalizeSpecificationObject).toBe('function');
+    });
+  });
+
   describe('Error handling', () => {
     beforeEach(() => {
       jest.clearAllMocks();