spiegel-keyman/web/docs/engine/reference/util/getOption.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

562 B

title
getOption

Summary

Get a KeymanWeb, On-Screen Keyboard or User Interface option value.

Syntax

keyman.util.getOption(optionName, dflt);

Parameters

optionName
Type: string
The named initialization option.
dflt
Type: string|Object optional
The value to return if the option is not set.

Return Value

string|Object
The value of the option (if set). If not set and no value is provided for dflt, returns the empty string.

Description

See also keyman.util.setOption().