Setting
(license MIT) library for store app setting in ini file, full example - see example.js
Kind: global class
- Setting
- .file
- .init(file) ⇒
string
- .set(section, option, value)
- .get(section, option, [default_value]) ⇒
string
|number
|boolean
- .getInt(section, option, [default_value]) ⇒
number
- .getFloat(section, option, [default_value]) ⇒
number
- .getBool(section, option, [default_value]) ⇒
boolean
- .getIp(section, option, [default_value]) ⇒
string
setting.file
{string}
Kind: instance property of Setting
string
setting.init(file) ⇒ set ini file name
Kind: instance method of Setting
Returns: string
- ini full file name or undefined
Param | Type | Description |
---|---|---|
file | string |
app full file name OR ini file name OR ini full file name |
setting.set(section, option, value)
save setting
Kind: instance method of Setting
Param | Type | Description |
---|---|---|
section | string |
section in ini file |
option | string |
option in ini file |
value | string | number | boolean |
value for option |
string
| number
| boolean
setting.get(section, option, [default_value]) ⇒ read setting
Kind: instance method of Setting
Returns: string
| number
| boolean
- string or number or boolean or undefined
Param | Type | Description |
---|---|---|
section | string |
section in ini file |
option | string |
option in ini file |
[default_value] | string | number | boolean |
default value for option |
number
setting.getInt(section, option, [default_value]) ⇒ read setting with type int
Kind: instance method of Setting
Returns: number
- number or undefined
Param | Type | Description |
---|---|---|
section | string |
section in ini file |
option | string |
option in ini file |
[default_value] | number |
default value for option |
number
setting.getFloat(section, option, [default_value]) ⇒ read setting with type float
Kind: instance method of Setting
Returns: number
- number or undefined
Param | Type | Description |
---|---|---|
section | string |
section in ini file |
option | string |
option in ini file |
[default_value] | number |
default value for option |
boolean
setting.getBool(section, option, [default_value]) ⇒ read setting with type boolean
Kind: instance method of Setting
Returns: boolean
- boolean or undefined
Param | Type | Description |
---|---|---|
section | string |
section in ini file |
option | string |
option in ini file |
[default_value] | boolean |
default value for option |
string
setting.getIp(section, option, [default_value]) ⇒ read setting with type ip
Kind: instance method of Setting
Returns: string
- string or undefined
Param | Type | Description |
---|---|---|
section | string |
section in ini file |
option | string |
option in ini file |
[default_value] | string |
default value for option |