gen-jhipster/dist/generators/base-application/support/enum.d.ts

VHipster - Spring Boot + Angular/React/Vue in one handy generator

import type { Field as BaseApplicationField } from '../types.d.ts';
type EnumValuesData = {
    withoutCustomValues: boolean;
    withSomeCustomValues: boolean;
    withCustomValues: boolean;
};
type EnumNameValue = {
    name: string;
    value: string;
    comment?: string;
};
/**
 * Build an enum object
 * @param {Object} field - entity field
 * @param {String} [clientRootFolder] - the client's root folder
 * @return {Object} the enum info.
 */
export declare const getEnumInfo: (field: Pick<BaseApplicationField, "enumInstance" | "fieldType" | "fieldValues" | "fieldValuesJavadocs" | "fieldTypeDocumentation">, clientRootFolder?: string) => EnumValuesData & {
    enumName: string;
    enumInstance: string;
    enums: string[];
    enumValues: EnumNameValue[];
    clientRootFolder: string;
    enumJavadoc?: string;
};
export {};