@serenity-is/corelib / EnumFormatter

Class: EnumFormatter

Defined in: src/ui/formatters/enumformatter.ts:7

Renders enum values as localized text via Enums.<EnumKey>.<Name>.

Implements

• Formatter

Constructors

Constructor

new EnumFormatter(props): EnumFormatter

Defined in: src/ui/formatters/enumformatter.ts:15

Creates a new EnumFormatter.

Parameters

props

Formatter options.

enumKey?

string

Full enum key (e.g. "MyProject.MyEnum"). Resolved via EnumTypeRegistry.

Returns

EnumFormatter

Properties

props

readonly props: object = {}

Defined in: src/ui/formatters/enumformatter.ts:15

Formatter options.

enumKey?

optional enumKey: string

---

[typeInfo]

static [typeInfo]: FormatterTypeInfo<"Serenity.">

Defined in: src/ui/formatters/enumformatter.ts:8

Accessors

enumKey

Get Signature

get enumKey(): string

Defined in: src/ui/formatters/enumformatter.ts:38

Gets the enum key used to resolve the enum type.

Returns

string

The enum key.

Set Signature

set enumKey(value): void

Defined in: src/ui/formatters/enumformatter.ts:43

Sets the enum key used to resolve the enum type.

Parameters

value

string

The enum key.

Returns

void

Methods

format()

format(ctx): FormatterResult

Defined in: src/ui/formatters/enumformatter.ts:24

Formats the enum value as localized text.

Parameters

ctx

FormatterContext

Formatter context containing the enum value.

Returns

FormatterResult

Localized enum text or a placeholder element when the enum type loads asynchronously.

Implementation of

Formatter.format

---

format()

static format(enumType, value): string

Defined in: src/ui/formatters/enumformatter.ts:51

Formats an enum value given an enum type.

Parameters

enumType

any

Registered enum object.

value

any

Enum numeric value.

Returns

string

Localized display text.

---

getName()

static getName(enumType, value): string

Defined in: src/ui/formatters/enumformatter.ts:82

Gets the member name for a value.

Parameters

enumType

any

Enum object.

value

any

Numeric value.

Returns

string

Enum member name or empty string.

---

getText()

static getText(enumKey, name): string

Defined in: src/ui/formatters/enumformatter.ts:69

Gets localized text for an enum name.

Parameters

enumKey

string

Enum key (e.g. "MyEnum").

name

string

Member name.

Returns

string

Localized string (falls back to name).