onBuildRoutePath
onBuildRoutePath: (data: BuildRoutePath) => undefined | BuildRoutePath
Optional
onCreateRequestParams
Optional
onCreateRouteName
onFormatRouteName?: ( routeInfo: RawRouteInfo, templateRouteName: string,) => undefined | string onFormatTypeName?: (
typeName: string,
rawTypeName?: string,
schemaType?: "enum-key" | "type-name",
) => undefined | string
Optional
onInit
onInit?: < C extends { addReadonly: boolean; anotherArrayType: boolean; apiClassName: string; authorizationToken?: string; cleanOutput: boolean; codeGenConstructs?: ( struct: CodeGenConstruct, ) => Partial<CodeGenConstruct>; compilerTsConfig: Record<string, unknown>; componentsMap: Record<string, SchemaComponent>; componentTypeNameResolver: ComponentTypeNameResolver; constants: constants; convertedFromSwagger2: boolean; customTranslator?: new () => Translator; debug: boolean; defaultResponseAsSuccess: boolean; defaultResponseType: string; disableThrowOnError: boolean; enumKeyPrefix: string; enumKeyResolverName: string; enumKeySuffix: string; enumNamesAsValues: boolean; extractEnums: boolean; extractingOptions: Partial<ExtractingOptions>; extractRequestBody: boolean; extractRequestParams: boolean; extractResponseBody: boolean; extractResponseError: boolean; extractResponses: boolean; extraTemplates: { name: string; path: string }[]; fileName: string; fileNames: { dataContracts: string; httpClient: string; outOfModuleApi: string; routeTypes: string; }; fixInvalidEnumKeyPrefix: string; fixInvalidTypeNamePrefix: string; generateClient: boolean; generateResponses: boolean; generateRouteTypes: boolean; generateUnionEnums: boolean; hooks: Partial<Hooks>; httpClientType: "fetch" | "axios"; input: string; internalTemplateOptions: { addUtilRequiredKeysType: boolean }; modular: boolean; moduleNameFirstTag: boolean; moduleNameIndex: number; originalSchema: object; output: string | false; patch: boolean; primitiveTypeConstructs?: ( struct: PrimitiveTypeStruct, ) => Partial<PrimitiveTypeStruct>; primitiveTypes: PrimitiveTypeStruct; requestOptions?: Partial<RequestInit>; routeNameDuplicatesMap: Map<string, string>; schemaParsers?: { array?: MonoSchemaParser; complex?: MonoSchemaParser; complexAllOf?: MonoSchemaParser; complexAnyOf?: MonoSchemaParser; complexNot?: MonoSchemaParser; complexOneOf?: MonoSchemaParser; discriminator?: MonoSchemaParser; enum?: MonoSchemaParser; object?: MonoSchemaParser; primitive?: MonoSchemaParser; }; silent: boolean; singleHttpClient: boolean; sortRoutes: boolean; sortTypes: boolean; spec: unknown; specificArgNameResolverName: string; successResponseStatusRange: [number, number]; swaggerSchema: object; templateExtensions: string[]; templateInfos: { fileName: string; name: string }[]; templatePaths: { base: string; custom: null | string; default: string; modular: string; original: string; }; templates: string; templatesToRender: { api: string; dataContractJsDoc: string; dataContracts: string; enumDataContract: string; httpClient: string; interfaceDataContract: string; objectFieldJsDoc: string; routeName: string; routeTypes: string; typeDataContract: string; }; toJS: boolean; Ts: CodeGenConstruct; typeNameResolverName: string; typePrefix: string; typeSuffix: string; unwrapResponseData: boolean; update: (update: Partial<GenerateApiConfiguration["config"]>) => void; url: string; version: string; },>( configuration: C, codeGenProcess: CodeGenProcess,) => undefined | C onInsertPathParam
onInsertPathParam: (
paramName: string,
index: number,
arr: BuildRouteParam[],
resultRoute: string,
) => undefined | string
onParseSchema
onParseSchema: (originalSchema: unknown, parsedSchema: unknown) => unknown
onPreBuildRoutePath
onPreBuildRoutePath: (routePath: string) => undefined | string
onPreParseSchema
onPreParseSchema: (
originalSchema: unknown,
typeName: string,
schemaType: string,
) => undefined
calls after parse\process route path