Skip to main content

getOption()

Last updated 2/10/2024

The

is a function on the

Five
object that returns a value of an option configured in the Options field against the instance of the running application. The key is passed into
getOption()
and this will return the value associated to the corresponding key.

Available

Server

Function Signature
getOption(key: string) : string;

ParameterTypeDescription
key
stringThe option key to retrieve the value

Return Value

A string representing the value from the key value pair in the Options field on the instance record.

Examples

getOption()