Class: Enumeration

bo.system. Enumeration

Serves as the base class for enumerations.

new Enumeration()

Creates a new enumeration. The enumeration instances should be frozen.

Members

<readonly> $name :string

The name of the enumeration. The default value is the name of the constructor.

Type:
  • string

Methods

check(value, message, messageParams)

Checks whether the enumeration has an item with the given value. If not, throws an error.

Parameters:
Name Type Argument Description
value number

The value to check.

message string <optional>

Human-readable description of the error.

messageParams * <optional>
<repeatable>

Optional interpolation parameters of the message.

Throws:
Enumeration error: The passed value is not an enumeration item.

count() → {number}

Returns the count of the items in enumeration.

Returns:

The count of the enumeration items.

Type
number

getName(value) → {string}

Returns the name of an enumeration item.

Parameters:
Name Type Description
value number

The enumeration item that name to be returned of.

Throws:
Returns:

The name of the enumeration item.

Type
string

getValue(name) → {number}

Returns the value of an enumeration item based on its name.

Parameters:
Name Type Description
name string

The enumeration item that value to be returned of.

Throws:
Returns:

The value of the enumeration item.

Type
number

hasMember(value) → {boolean}

Determines if the enumeration has an item with the given value.

Parameters:
Name Type Description
value number

The value to check.

Returns:

True if the value is an enumeration item, otherwise false.

Type
boolean

hasValue(name) → {boolean}

Determines if the enumeration has an item with the given name.

Parameters:
Name Type Description
name string

The name of the enumeration item.

Returns:

True if the name is an enumeration item, otherwise false.

Type
boolean
If you find bugs or have feature requests, please let us know.

JavaScript business objects ♦ Copyright © 2014-2016 Logikum, Ltd.
Documentation generated by JSDoc 3.2.2 on 2015. December 31. using the DocStrap template.