refactor: Remove save opts #54

joolfe · Aug 2, 2020 · f6c3148 · f6c3148
1 parent 0ed6a0a
commit f6c3148
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -43,9 +43,11 @@ Use the library is as easy as use a single method `async postmanToOpenApi(inputP
 
 | Param        | Description                                                                                 |
 |--------------|---------------------------------------------------------------------------------------------|
-| `options`    | Object. Optional configuration, see [options](#options) section for a detailed description. |
 | `inputPath`  | String. Path of the Postman collection file.                                                |
-| `outputPath` | String. Path of the output file where the OpenAPi will be stored.                           |
+| `outputPath` | String. Path of the output file where the OpenAPi will be stored. This param is optional if not provided (`undefined` or `null`) no file will be saved. |
+| `options`    | Object. Optional configuration, see [options](#options) section for a detailed description. |
+
+The method return a promise string that contain the yml OpenAPI specification, only is saved to a file if the `outputPath` parameter is provided.
 
 An example of usage:
 
@@ -58,6 +60,8 @@ const outputFile = './api/collection.yml'
 // Async/await
 try {
     const result = await postmanToOpenApi(postmanCollection, outputFile, { save: true })
+    // Without save the result in a file
+    const result2 = await postmanToOpenApi(postmanCollection, null, { save: true })
     console.log(`OpenAPI specs: ${result}`)
 } catch (err) {
     console.log(err)

diff --git a/lib/index.js b/lib/index.js
@@ -3,7 +3,7 @@
 const { promises: { writeFile, readFile } } = require('fs')
 const { safeDump } = require('js-yaml')
 
-async function postmanToOpenApi (input, output, { save = true, info = {}, defaultTag = 'default', auth, servers } = {}) {
+async function postmanToOpenApi (input, output, { info = {}, defaultTag = 'default', auth, servers } = {}) {
   // TODO validate?
   const collectionFile = await readFile(input)
   const postmanJson = JSON.parse(collectionFile)
@@ -51,7 +51,7 @@ async function postmanToOpenApi (input, output, { save = true, info = {}, defaul
   }
 
   const openApiYml = safeDump(openApi)
-  if (save) {
+  if (output != null) {
     await writeFile(output, openApiYml, 'utf8')
   }
   return openApiYml

diff --git a/test/index.spec.js b/test/index.spec.js
@@ -48,7 +48,7 @@ describe('Library specs', function () {
   })
 
   it('should work when no save', async function () {
-    await postmanToOpenApi(COLLECTION_BASIC, '', { save: false })
+    await postmanToOpenApi(COLLECTION_BASIC, null)
   })
 
   it('should work if info is passed as parameter', async function () {