typescript-scaffolder
Version:
 ### Unit Test Coverage: 97.12%
22 lines • 1.27 kB
TypeScript
import { Endpoint, EndpointAuthConfig } from 'models/api-definitions';
export declare function generateApiClientFunction(baseUrl: string, fileName: string, functionName: string, endpoint: Endpoint, config: EndpointAuthConfig, interfaceInputDir: string, clientOutputDir: string, writeMode?: 'overwrite' | 'append'): void;
/**
* Generates a grouped API client file from a client endpoint config file.
*
* Assumes each endpoint includes a `modelName` (e.g., "person") used for
* determining both the function name and output file name.
*
* @param configPath - Path to the EndpointClientConfigFile JSON
* @param interfacesDir - Path to where the interfaces are stored
* @param outputDir - Output directory
*/
export declare function generateApiClientFromFile(configPath: string, interfacesDir: string, outputDir: string): Promise<void>;
/**
* Takes in a config directory, a directory of interfaces, and output directories and scaffolds out
* all API clients based on the config and interfaces available
* @param configDir
* @param interfacesRootDir
* @param outputRootDir
*/
export declare function generateApiClientsFromPath(configDir: string, interfacesRootDir: string, outputRootDir: string): Promise<void>;
//# sourceMappingURL=generate-api-client.d.ts.map