Class: Enum

Extends

• ReflectionObject

Members

comment { string | null }

enum.js, line 45

Enum comment text.

comments { Object<string, (string|null)> }

enum.js, line 51

Value comment texts, if any.

filename { string | null }

object.js, line 103

Defining file name.

fullName readonly{ string }

object.js, line 123

Full name including leading dot.

name { string }

object.js, line 50

Unique name within its namespace.

options { Object<string, *> | undefined }

object.js, line 38

Options.

parent { Namespace | null }

object.js, line 85

Parent namespace.

parsedOptions { Object<string, *>[] | undefined }

object.js, line 44

Parsed Options.

reserved { (number[]|string)[] }

enum.js, line 69

Reserved ranges, if any.

resolved { boolean }

object.js, line 91

Whether already resolved or not.

root readonly{ Root }

object.js, line 108

Reference to the root namespace.

values { Object<string, number> }

enum.js, line 39

Enum values by name.

valuesById { Object<number, string> }

enum.js, line 33

Enum values by id.

valuesOptions { Object<string, Object<string, *>> | undefined }

enum.js, line 57

Values options, if any

Methods

add(name, id, comment, options)→{ Enum }

enum.js, line 152

Adds a value to this enum.

Parameters:

name	string	Value name
id	number	Value id
comment	string	optional Comment, if any
options	Object.<string, *> | undefined	optional Options, if any

Throws:

TypeError	If arguments are invalid
Error	If there is already a value with this name or id

Returns:

Enum

this

inherited getOption(name)→{ * }

object.js, line 272

Gets an option value.

Parameters:

name

string

Option name

Returns:

*	Option value or undefined if not set

isReservedId(id)→{ boolean }

enum.js, line 220

Tests if the specified id is reserved.

Parameters:

id

number

Id to test

Returns:

boolean

true if reserved, otherwise false

isReservedName(name)→{ boolean }

enum.js, line 229

Tests if the specified name is reserved.

Parameters:

name

string

Name to test

Returns:

boolean

true if reserved, otherwise false

inherited onAdd(parent)→{ undefined }

object.js, line 155

Called when this object is added to a parent.

Parameters:

parent

ReflectionObject

Parent added to

Returns:

undefined

inherited onRemove(parent)→{ undefined }

object.js, line 170

Called when this object is removed from a parent.

Parameters:

parent

ReflectionObject

Parent removed from

Returns:

undefined

remove(name)→{ Enum }

enum.js, line 197

Removes a value from this enum

Parameters:

name

string

Value name

Throws:

TypeError	If arguments are invalid
Error	If name is not a name of this enum

Returns:

Enum

this

inherited resolve()→{ ReflectionObject }

object.js, line 182

Resolves this objects type references.

Returns:

ReflectionObject

this

inherited setOption(name, value, ifNotSet)→{ ReflectionObject }

object.js, line 285

Sets an option.

Parameters:

name	string	Option name
value	*	Option value
ifNotSet	boolean | undefined	optional Sets the option only if it isn't currently set

Returns:

ReflectionObject

this

inherited setOptions(options, ifNotSet)→{ ReflectionObject }

object.js, line 347

Sets multiple options.

Parameters:

options	Object.<string, *>	Options to set
ifNotSet	boolean	optional Sets an option only if it isn't currently set

Returns:

ReflectionObject

this

inherited setParsedOption(name, value, propName)→{ ReflectionObject }

object.js, line 307

Sets a parsed option.

Parameters:

name	string	parsed Option name
value	*	Option value
propName	string	dot '.' delimited full path of property within the option to set. if undefined\empty, will add a new option with that value

Returns:

ReflectionObject

this

toJSON(toJSONOptions)→{ IEnum }

enum.js, line 129

Converts this enum to an enum descriptor.

Parameters:

toJSONOptions

IToJSONOptions

optional JSON conversion options

Returns:

IEnum

Enum descriptor

inherited toString()→{ string }

object.js, line 358

Converts this instance to its string representation.

Returns:

string

Class name[, space, full name]

Enum.fromJSON(name, json)→{ Enum }

enum.js, line 115

Constructs an enum from an enum descriptor.

Parameters:

name	string	Enum name
json	IEnum	Enum descriptor

Throws:

TypeError

If arguments are invalid

Returns:

Enum	Created enum