Package Exports
- cf-prefs
- cf-prefs/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cf-prefs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
cf-prefs
$ yarn add cf-prefsThis 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)
keyString - 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)
keyString - 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.