openapi-to-ts
Version:
Generate TypeScript types from OpenAPI 3.0 specs.
10 lines (9 loc) • 511 B
TypeScript
import { IOpenAPISpecFile } from './types';
/**
* This function loads an OpenAPI 3.0 specification file
* and converts it into JSON. It can either be on a remote
* server or on the local file system of the user.
* @param filePath the path to the OpenAPI 3.0 specification file to convert.
* @param githubToken the github token that should be attached to the request.
*/
export declare const getOpenAPISpecAsJSON: (filePath: string, githubToken?: string | undefined) => Promise<IOpenAPISpecFile>;