qie.deduceBoolean¶
Signature: qie.deduceBoolean(value, expanded*)
Returns: Boolean booleanValue - the Boolean value of the string value
Convert a string value to it's Boolean equivalent (true or false).
Note
Use when retrieving Boolean values from messageCache or source/message objects.
Parameters¶
| Type | Name | Description | Default |
|---|---|---|---|
| String | value | the string representation of the boolean value to be converted | |
| Boolean | expanded* | (optional) when true, recognizes a wider range of commonly used Boolean-like values | false |
Example¶
// The word 'true' (case-insensitive) and all positive
// integer values (>0) evaluate to `true`.
// All other `values` evaluate to `false`.
// Example using deduceBoolean with messageCache values
var myBoolean = true;
// Storing the value in message cache will convert it to a string
messageCache.setValue('myBoolean', myBoolean);
// ...
// Call qie.deduceBoolean() when retrieving the value
if (qie.deduceBoolean(messageCache.getValue('myBoolean'))) {
qie.debug("myBoolean = true");
}
// Example values that evaluate to `true`
qie.debug("'TRUE' -> " + qie.deduceBoolean("TRUE")); // true
qie.debug("'True' -> " + qie.deduceBoolean("True")); // true
qie.debug("'true' -> " + qie.deduceBoolean("true")); // true
qie.debug("'10' -> " + qie.deduceBoolean("10")); // true
qie.debug("'2' -> " + qie.deduceBoolean("2")); // true
qie.debug("'1' -> " + qie.deduceBoolean("1")); // true
// Example values that evaluate to `false`
qie.debug("'0' -> " + qie.deduceBoolean("0")); // false
qie.debug("'-1' -> " + qie.deduceBoolean("-1")); // false
qie.debug("'-2' -> " + qie.deduceBoolean("-2")); // false
qie.debug("'-10' -> " + qie.deduceBoolean("-10")); // false
qie.debug("'false' -> " + qie.deduceBoolean("false")); // false
qie.debug("'False' -> " + qie.deduceBoolean("False")); // false
qie.debug("'FALSE' -> " + qie.deduceBoolean("FALSE")); // false
// Example values that evaluate to `true` when expanded = true
qie.debug("'t' -> " + qie.deduceBoolean("t", true)); // true
qie.debug("'y' -> " + qie.deduceBoolean("y", true)); // true
qie.debug("'yes' -> " + qie.deduceBoolean("yes", true)); // true
qie.debug("'on' -> " + qie.deduceBoolean("on", true)); // true
qie.debug("'enabled' -> " + qie.deduceBoolean("enabled", true)); // true
qie.debug("'active' -> " + qie.deduceBoolean("active", true)); // true
qie.debug("'checked' -> " + qie.deduceBoolean("checked", true)); // true
// Example values that evaluate to `false` when expanded = true
qie.debug("'f' -> " + qie.deduceBoolean("f", true)); // false
qie.debug("'n' -> " + qie.deduceBoolean("n", true)); // false
qie.debug("'no' -> " + qie.deduceBoolean("no", true)); // false
qie.debug("'off' -> " + qie.deduceBoolean("off", true)); // false
qie.debug("'disabled' -> " + qie.deduceBoolean("disabled", true)); // false
qie.debug("'inactive' -> " + qie.deduceBoolean("inactive", true)); // false
qie.debug("'unchecked' -> " + qie.deduceBoolean("unchecked", true));// false