Interface PartialEnumData

A partial EnumData.

interface PartialEnumData {
    constants: Collection<string, EnumConstantData>;
    deprecation: null | DeprecationContent;
    description: null | NodeContent;
    entityType: "enum";
    fields: Collection<string, FieldData<null | InterfaceData>>;
    id: string;
    methods: Collection<string, MethodData<null | InterfaceData>>;
    name: string;
    partialImplements: (string | ExternalEntityData)[];
    partialPackage: PartialPackageData;
    qualifiedName: string;
    signature: string;
    url: string;
}

Hierarchy

  • Omit<EnumData, "package" | "implements">
    • PartialEnumData

Properties

constants deprecation description entityType fields id methods name partialImplements partialPackage qualifiedName signature url

Properties

constants

constants: Collection<string, EnumConstantData>

The enum's constants, in their ordinal order, keyed by their EnumConstantData#name.

deprecation

deprecation: null | DeprecationContent

The enum's deprecation notice, if any.

This property is always present if the enum is deprecated, regardless of whether it the notice any description or not.

description

description: null | NodeContent

The entity's description, if any.

entityType

entityType: "enum"

The entity's type.

fields

fields: Collection<string, FieldData<null | InterfaceData>>

The enum's fields, keyed by their FieldData#name.

id

id: string

The entity's unique id (relative to others in the same context). Used as key in collections.

Specifically:

  • In classes, enums, interfaces, external objects and annotations: the qualifiedName.
  • In packages, enum constants, fields, method type parameters, object type parameters and parameters: the name.
  • In methods: the prototype, to avoid conflicts with overloaded methods.

methods

methods: Collection<string, MethodData<null | InterfaceData>>

The enum's methods, keyed by their MethodData#prototype.

name

name: string

The entity's name.

partialImplements

partialImplements: (string | ExternalEntityData)[]

Can be an interface's fully qualified name, or an ExternalEntityData.

partialPackage

partialPackage: PartialPackageData

qualifiedName

qualifiedName: string

The fully qualified name of the enum.

signature

signature: string

The entity's signature.

url

url: string

The enum's Javadocs URL.

Settings

Member Visibility

On This Page

Properties