osx-defaults v1.0.3

osx-defaults

This module provides access to defaults program via simple API.

Usage

Information about defaults program itself available here.

Here is basic usage, you can also browse examples directory.

'use strict';

const defaults = require('osx-defaults');

let value = defaults.read({
  isGlobalDomain: true,
  key: 'AppleInterfaceStyle'
});

console.log(value); // Will output "Dark" or null if value is not set/exists

let result = defaults.write({
    isGlobalDomain: true,
    key: 'AppleInterfaceStyle',
    valueType: defaults.STRING,
    value: 'Dark'
});

if (result) {
  console.log('Value of AppleInterfaceStyle updated');
}

API

• defaults.read(options[, next])
• defaults.write(options[, next])
• defaults.rename(options[, next])
• defaults.delete(options[, next])

If you provide next callback, then execution will be performed asynchronously.

next callback is a function of the following form:

function(error, result) {
  // do stuff here
}

Options

hostname

Restricts preferences operations to hostname.

isCurrentHost

Restricts preferences operations to the host the user is currently logged in on.

domain

If no isGlobalDomain flag is specified, domain is a domain name of the form com.companyname.appname. Example: 'com.apple.TextEdit'.

The name of application may be provided instead of domain using the -app prefix. Example: '-app TextEdit'.

Domains may also be specified as a path to an arbitrary plist file, with or without the '.plist' extension. Example: '~/Library/Containers/com.apple.TextEdit/Data/Library/Preferences/com.apple.TextEdit.plist'.

WARNING: The defaults command will be changed in an upcoming major release to only operate on preferences domains. General plist manipulation utilities will be folded into a different command-line program.

isGlobalDomain

Specify the global domain.

key

The identifier of the default.

valueType

Specify value type for preference keys. String is used by default, you can also use following constants to specify the value:

• STRING
• INT or INTEGER
• FLOAT
• BOOL or BOOLEAN
• ARRAY

• DICT or DICTIONARY

  Example:

   'use strict';
  
   const defaults = require('osx-defaults');
  
   defaults.write({
       isGlobalDomain: true,
       key: 'foo',
       valueType: defaults.INT, // Value is integer
       value: 1
   });
  
   defaults.write({
       isGlobalDomain: true,
       key: 'bar',
       valueType: defaults.FLOAT, // Value is float
       value: Math.PI
   });

value

Specify the default value when using defaults.write method.

new_key

Specify new key name when using defaults.rename method.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.