openwrt-mirror/luci
1
0
Fork 0
mirror of https://github.com/openwrt/luci.git synced 2025-12-21 17:04:35 +04:00
Code Issues Packages Projects Releases Wiki Activity

luci-base: improve docs for uci.get_bool

Browse Source 
The get_bool function documentation was missing an option value, so
add it.  Provide a link into the developer's guide on how it's used
in scripts, for better background.

Signed-off-by: Eric Fahlgren <ericfahlgren@gmail.com>
This commit is contained in:
Eric Fahlgren
2025-11-12 11:11:57 -08:00
committed by Paul Donald
parent 8c2b57588b
commit 9717162fd0
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
modules/luci-base/htdocs/luci-static/resources/uci.js
View File

@@ -711,8 +711,9 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ {
* Many configuration files contain boolean settings, such as
* `enabled` or `advanced_mode`, where there is no consistent
* definition for the values. This function allows users to
* enter any of the values `"yes"`, `"on"`, `"true"` or `1` in
* their config files and we return the expected boolean result.
* enter any of the values `"yes"`, `"on"`, `"true"`, `"enabled"`
* or `1` in their config files and we return the expected boolean
* result.
*
* Character case is not significant, so for example, any of
* "YES", "Yes" or "yes" will be interpreted as a `true` value.
@@ -730,6 +731,10 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ {
* @returns {boolean}
* - Returns boolean `true` if the configuration value is defined
* and looks like a true value, otherwise returns `false`.
*
* See the
* {@link https://openwrt.org/docs/guide-developer/config-scripting#reading_booleans|Developers Guide}
* for more.
*/
get_bool(conf, type, opt) {
let value = this.get(conf, type, opt);