Class OnmsEnum<T>

Represents an enumerated type.

Type parameters

T

Hierarchy

OnmsEnum

Index

Constructors

constructor

Properties

i
l

Accessors

Methods

Constructors

constructor

new OnmsEnum(id: T, label: string): OnmsEnum

- Defined in internal/OnmsEnum.ts:26
construct an enum object with an id and label

Parameters
- id: T
- label: string
Returns OnmsEnum

Properties

Private i

i: T

the internal index/id

Private l

l: string

the type/label

Accessors

id

get id(): T

- Defined in internal/OnmsEnum.ts:14
get the index/id of this enum entry

Returns T

index

get index(): T

- Defined in internal/OnmsEnum.ts:19
an alias for OnmsEnum.id

Returns T

label

get label(): string

- Defined in internal/OnmsEnum.ts:24
get the label of this enum entry

Returns string

Methods

toDisplayString

toDisplayString(): string

- Defined in internal/OnmsEnum.ts:35
convert this enum to a string suitable for display

Returns string

toJSON

toJSON(): object

- Defined in internal/OnmsEnum.ts:45
convert to the JSON representation

Returns object
- id: T
- label: string

toString

toString(): T

- Defined in internal/OnmsEnum.ts:40
convert this enum to a string

Returns T

Generated using TypeDoc