UNPKG

@zimic/http

Version:

Next-gen TypeScript-first HTTP utilities

github.com/zimicjs/zimic

zimicjs/zimic

22 lines (20 loc) • 1.66 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ interface OpenAPITypegenOptions { /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ input: string; /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ output?: string; /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ serviceName: string; /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ includeComments: boolean; /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ prune: boolean; /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ filters?: string[]; /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ filterFile?: string; } /** @see {@link https://zimic.dev/docs/http/api/typegen#generatetypesfromopenapi `generateTypesFromOpenAPI()` API reference} */ declare function generateTypesFromOpenAPI({ input: inputFilePathOrURL, output: outputFilePath, serviceName, includeComments, prune, filters: filtersFromArguments, filterFile, }: OpenAPITypegenOptions): Promise<void>; export { type OpenAPITypegenOptions, generateTypesFromOpenAPI };