diff --git a/.changeset/stupid-walls-act.md b/.changeset/stupid-walls-act.md new file mode 100644 index 000000000..b9012a6bd --- /dev/null +++ b/.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`. diff --git a/README.md b/README.md index ad6bb43b1..559f60bd2 100644 --- a/README.md +++ b/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", diff --git a/types/index.ts b/types/index.ts index 17fdf6e90..50ef1233e 100644 --- a/types/index.ts +++ b/types/index.ts @@ -9,7 +9,7 @@ interface GenerateApiParamsBase { /** * default 'api.ts' */ - name?: string; + fileName?: string; /** * name of the main exported class