Merge pull request #1069 from yangdan8/patch-1

Fix parameter name to fileName

Author: smorimoto

.changeset/stupid-walls-act.md

@@ -0,0 +1,5 @@
+---
+"swagger-typescript-api": patch
+---
+
+Fix documentation and type definition to align with actual implementation by renaming `name` to `fileName`.

README.md

@@ -84,7 +84,7 @@ import { generateApi, generateTemplates } from "swagger-typescript-api";
 
 /* NOTE: all fields are optional expect one of `input`, `url`, `spec` */
 generateApi({
-  name: "MySuperbApi.ts",
+  fileName: "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",

types/index.ts

@@ -9,7 +9,7 @@ interface GenerateApiParamsBase {
   /**
    * default 'api.ts'
    */
-  name?: string;
+  fileName?: string;
 
   /**
    * name of the main exported class