Helpful
    Preparing search index...

    Interface IZEnumInfo<TEnum>

    Information for an enum value.

    This is useful for front end development when you want to map an enumeration like value to things like a display name, description, and avatar. ECMAScript does not support decorators for literal fields so this is an alternative to describe that kind of information.

    This is similar to Metadata from helpful-query, but it's much more specific and specialized to enumerations.

    interface IZEnumInfo<TEnum extends string | number> {
        avatar?: any;
        description?: string;
        name?: string;
        value: TEnum;
    }

    Type Parameters

    • TEnum extends string | number
    Index

    Properties

    avatar?: any

    The avatar representation of the enum.

    This can be anything and is contextual of how this object is used.

    description?: string

    The description of the enum value.

    name?: string

    The display name of the enum value.

    value: TEnum

    The value being described.