@serenity-is/corelib / EnumFormatter

Class: EnumFormatter

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

Implements

• Formatter

Constructors

Constructor

new EnumFormatter(props): EnumFormatter

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

Parameters

props

enumKey?

string

Returns

EnumFormatter

Properties

props

readonly props: object = {}

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

enumKey?

optional enumKey: string

---

[typeInfo]

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

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

Accessors

enumKey

Get Signature

get enumKey(): string

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

Returns

string

Set Signature

set enumKey(value): void

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

Parameters

value

string

Returns

void

Methods

format()

format(ctx): FormatterResult

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

Parameters

ctx

FormatterContext

Returns

FormatterResult

Implementation of

Formatter.format

---

format()

static format(enumType, value): string

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

Parameters

enumType

any

value

any

Returns

string

---

getName()

static getName(enumType, value): string

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

Parameters

enumType

any

value

any

Returns

string

---

getText()

static getText(enumKey, name): string

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

Parameters

enumKey

string

name

string

Returns

string