Settings
settings : object
PostalPoint provides a UI for user-configurable plugin settings. See exports.config in examples/basic-demo/plugin.js for details. Settings are typically very short strings. Do not store data in settings. For data storage, see Storing Data. Non-string settings values are transparently converted to/from JSON objects. Use a unique key name prefix for your plugin to prevent key name conflicts. Reverse domain style is recommended (i.e. "com.example.pluginname.keyname").
Kind: global namespace
- settings :
object
settings.get(key, defaultValue) ⇒ *
Get a setting.
Kind: static method of settings
| Param | Type | Description |
|---|---|---|
| key | string |
Setting key/ID |
| defaultValue | * |
Value to return if setting has no stored value. |
settings.set(key, value)
Set a setting.
Kind: static method of settings
| Param | Type | Description |
|---|---|---|
| key | string |
Setting key/ID |
| value | string |
Value to set. |