document approach to disabling output (#325)

Author: Ben Watkins

README.md

@@ -90,6 +90,7 @@ const fs = require("fs");
 /* NOTE: all fields are optional expect one of `output`, `url`, `spec` */
 generateApi({
   name: "MySuperbApi.ts",
+  // set to `false` to prevent the tool from writing to disk
   output: path.resolve(process.cwd(), "./src/__generated__"),
   url: 'http://api.com/swagger.json',
   input: path.resolve(process.cwd(), './foo/swagger.json'),

index.d.ts

@@ -5,9 +5,12 @@ interface GenerateApiParamsBase {
   name?: string;
 
   /**
-   * path to folder where will been located the created api module
+   * path to folder where will been located the created api module.
+   *
+   * may set to `false` to skip writing content to disk. in this case,
+   * you may access the `files` on the return value.
    */
-  output?: string;
+  output?: string | false;
 
   /**
    * path to folder containing templates (default: ./src/templates)