preferences-service
The preferences-service
module provides access to the
application-wide preferences service singleton.
API Reference
Functions
set(name, value)
Sets the application preference name
to value
.
name : string
Preference name.
value : string,number,bool
Preference value.
Example:
var name = "extensions.checkCompatibility.nightly";
require("preferences-service").set(name, false);
get(name, defaultValue)
Gets the application preference name
.
name : string
defaultValue : string,number,bool
Preference value.
Returns: string,number,bool
Preference value, returns a default value if no preference is set.
Example:
var name = "extensions.checkCompatibility.nightly";
var nightlyCompatChk = require("preferences-service").get(name);
has(name)
name : string
Preference name.
Returns: bool
Returns whether or not the application preference name
exists.
Example:
var name = "extensions.checkCompatibility.nightly";
if (require("preferences-service").has(name)) {
// ...
}
isSet(name)
name : string
Preference name.
Returns: bool
Returns whether or not the application preference name
both exists
and has been set to a non-default value by the user (or a program
acting on the user's behalf).
Example:
var name = "extensions.checkCompatibility.nightly";
if (require("preferences-service").isSet(name)) {
// ...
}
reset(name)
Clears a non-default, user-set value from the application preference
name
. If no user-set value is defined on name
, the function
does nothing.
name : string
Preference name.
Example:
var name = "extensions.checkCompatibility.nightly";
require("preferences-service").reset(name);