cf-prefs
v2.0.1
Published
A native node module to access managed app preferences on macOS
Downloads
1,981
Maintainers
Readme
cf-prefs
$ yarn add cf-prefs
This native Node.js module allows you to read managed app preferences on macOS. It maps to the underlying CFPreferencesCopyAppValue
family of APIs. This module only truly works in apps with valid bundle IDs (i.e. Electron apps).
API
prefs.getPreferenceValue(key)
key
String - The preference key to fetch the value of, has to be a valid UTF-8 string.
Returns String
| Integer
| Boolean
| Object
| Array
| undefined
Notes:
- If the preference is not available you will receive
undefined
.
Example:
console.log('My Preference Value:', prefs.getPreferenceValue('MyAppsCoolPreference'))
permissions.isPreferenceForced(key)
key
String - The preference key to determine if the value is forced, has to be a valid UTF-8 string.
Returns Boolean
- Whether the preference key is "forced", if this method returns true you should not allow users to override this preference in your application as a system administrator has indicated this preference key is "forced". For more information check out the apple API docs.