UNPKG

openapi-codegen-typescript

Version:

OpenApi codegen for generating types an mocks from swagger json file

54 lines (53 loc) 2.51 kB
import { ConvertRefType, EnumProps, EnumSchema, GetAdditionalPropertiesProps, GetArrayOfItemsMockProps, GetArrayOfOneOfMockProps, GetDictionaryMockProps, GetNumberMockProps, GetRefTypeMockProps, GetStringMockProps, MockArrayProps } from './types'; export declare class MockGenerateHelper { private casual; constructor(casual: Casual.Generators & Casual.Casual); getStringMock({ name, propertyName, format }: GetStringMockProps): MockArrayProps; /** * Returns mock data for types 'integer' and 'double' * @param propertyName * @param type * @param minimum * @param maximum */ getNumberMock({ propertyName, type, minimum, maximum }: GetNumberMockProps): MockArrayProps; /** * Returns mock data for type 'boolean' * @param propertyName */ getBooleanMock(propertyName: string): MockArrayProps; /** * Returns mock data for array of values. * Could return array of DTOs, Enums, Strings, Doubles... * @param propertyName * @param items * @param DTOs */ getArrayOfItemsMock({ propertyName, items, DTOs }: GetArrayOfItemsMockProps): MockArrayProps; /** * Return one element of Enum or DTO * @param propertyName * @param oneOf * @param DTOs * @param overrideSchemas */ getDtoMock({ propertyName, oneOf, DTOs, overrideSchemas }: GetArrayOfOneOfMockProps): MockArrayProps; static getDictionaryResultValue({ enumValues, value, }: { enumValues: Array<string>; value: string | Function; }): string; getDictionaryMock({ propertyName, xDictionaryKey, additionalProperties, DTOs, overrideSchemas, }: GetDictionaryMockProps): MockArrayProps; getAdditionalPropertiesMock({ propertyName, additionalProperties }: GetAdditionalPropertiesProps): MockArrayProps; getAnyMock({ propertyName }: { propertyName: string; }): MockArrayProps; getRefTypeMock: ({ $ref, propertyName, DTOs, overrideSchemas }: GetRefTypeMockProps) => MockArrayProps; static parseRefType: (refType: string[]) => string; static getOverridedSchema: (schemaName: string, overrideSchemas?: EnumSchema[] | undefined) => EnumProps | undefined; static joinVariableNamesAndValues: (varNamesAndValues: MockArrayProps[]) => string; static getMockTemplateString: ({ typeName, varNamesAndValues }: any) => string; static convertRefType: ({ propertyName, ref, isArray, }: ConvertRefType) => { propertyName: string; value: any; }; }