Class ZEnumInfoBuilder<TEnum>

Builds information for an enum.

Type Parameters

TEnum extends string | number

Index

Constructors

Methods

avatar build description name

Constructors

constructor

new ZEnumInfoBuilder<TEnum extends string | number>(
value: TEnum,
): ZEnumInfoBuilder<TEnum>
Initializes a new instance of this object.
Type Parameters
- TEnum extends string | number
Parameters
- value: TEnum
  The value to initialize with.
Returns ZEnumInfoBuilder<TEnum>
- Defined in enum/enum-info.mts:52

Methods

avatar

avatar(avatar: any): ZEnumInfoBuilder<TEnum>
The avatar representation of the enum.
Parameters
- avatar: any
  The avatar representation of what the value is. This can be anything but should be related to the framework it is being developed for.
Returns ZEnumInfoBuilder<TEnum>
This object.
- Defined in enum/enum-info.mts:95

build

build(): IZEnumInfo<TEnum>
Returns a shallow copy of the metadata.

Returns IZEnumInfo<TEnum>
A shallow copy of the metadata.
- Defined in enum/enum-info.mts:106

description

description(description: string): ZEnumInfoBuilder<TEnum>
Text description of the enum.
Parameters
- description: string
  Text description of what the value means.
Returns ZEnumInfoBuilder<TEnum>
This object.
- Defined in enum/enum-info.mts:79

name

name(name: string): ZEnumInfoBuilder<TEnum>
The display name of the enum.
Parameters
- name: string
  The display name of the enum.
Returns ZEnumInfoBuilder<TEnum>
This object.
- Defined in enum/enum-info.mts:65