Option

Represents an settings elemet.

Methods

Returns the ID of the option.

getId(): string

Returns

string

---

Set the ID of the option.

setId(id): void

Parameters

Name	Type	Description
id	string	The ID of the option.

---

Returns the name of the option.

getName(): string

Returns

string

---

Set the name of the option.

setName(name): void

Parameters

Name	Type	Description
name	string

---

Returns the type of the option.

getType(): OptionType

Returns

OptionType

---

Set the type of the option.

setType(type): void

Parameters

Name	Type	Description
type	OptionType

---

Returns the value of the option.

getValue(): null

Returns

null

---

Set the value of the option.

setValue(value): void

Parameters

Name	Type	Description
value	any

---

Returns the default value of the option.

getDefault(): null

Returns

null

---

Returns the categories of the option.

getCategories(): string[]

Returns

string[]

---

Set the default value of the option.

setDefault(value): void

Parameters

Name	Type	Description
value	any

---

Returns true if the option is a boolean.

isBoolean(): boolean

Returns

boolean

---

Returns true if the option is a string.

isString(): boolean

Returns

boolean

---

Returns true if the option is a float.

isFloat(): boolean

Returns

boolean

---

Returns true if the option is an integer.

isInt(): boolean

Returns

boolean

---

Converts the received JSON data into a Option object.

fromJSON(json): Option

Parameters

Name	Type	Description
json	any

Returns

Option

---

Converts the options object to valid JSON data.

toJSON(): any

Returns

any

---