getBoolean Method


getBoolean(name)

Get the value of a boolean property by name.

getBoolean(name: string): boolean | undefined

@returns the property's value if it exists and is a boolean, undefined otherwise.

Parameter Type Description
name string  

Returns - boolean | undefined

the property's value if it exists and is a boolean, undefined otherwise.



getBoolean(name, defaultValue)

Get the value of a boolean property by name.

getBoolean(name: string, defaultValue: boolean): boolean

@returns the property's value if it exists and is a boolean, otherwise the supplied default value.

Parameter Type Description
name string  
defaultValue boolean  

Returns - boolean

the property's value if it exists and is a boolean, otherwise the supplied default value.


Defined in

Last Updated: 09 May, 2026