Skip to content

Latest commit

 

History

History
170 lines (119 loc) · 5.86 KB

README.md

File metadata and controls

170 lines (119 loc) · 5.86 KB
Raw

MIT license PRs Welcome Lint Status Test Status

node-mac-userdefaults

$ npm i node-mac-userdefaults

This native Node.js module provides an interface to the user’s defaults database on macOS.

API

defaults.getAllDefaults([domain])

  • domain String (optional) - The domain identifier for an NSUserDefaults suite.

Returns Record<string, any> - An object containing all currently set defaults and their values for the current user.

Example:

const { getAllDefaults } = require('node-mac-userdefaults')

const allDefaults = getAllDefaults()

console.log(allDefaults)
/*
{
  'com.apple.springing.enabled': 1,
  'Brother MFC-J985DW': '1',
  'com.apple.trackpad.enableSecondaryClick': 1,
  'HP DeskJet 2600 series': '1',
  'com.apple.trackpad.rotateGesture': 1,
  NSNavPanelFileListModeForOpenMode2: 3,
  Country: 'US',
  'com.apple.preferences.timezone.selected_city': {
    AppleMapID: '\x1Dq\x13\x13u\x1C\x19'
  },
  'Brother MFC-L9570CDW series': '1',
  WebAutomaticSpellingCorrectionEnabled: 1,
  'com.apple.trackpad.momentumScroll': 1,
  AKLastIDMSEnvironment: 0,
  'Hewlett Packard MFP M477fdn': '1',
  NSAutomaticTextCompletionCollapsed: 0,
  'com.apple.trackpad.fourFingerPinchSwipeGesture': 2,
  AppleShowAllExtensions: 1,
  'com.apple.trackpad.threeFingerTapGesture': 0,
  NSQuitAlwaysKeepsWindows: 0,
  'com.apple.trackpad.fourFingerVertSwipeGesture': 2,
  NSLinguisticDataAssetsRequestTime: '2020-06-10 00:57:28 +0000',
  NSAutomaticPeriodSubstitutionEnabled: 1,
  'com.apple.springing.delay': 0,
  'HP ENVY 5000 series': '1',
  'com.apple.sound.beep.flash': 0,
  AppleShowScrollBars: 'Automatic',
  ...
*/

defaults.getUserDefault(type, key[, domain])

  • key String - The NSUserDefault to fetch, e.g AppleInterfaceStyle.
  • type String - Can be one of string, boolean, integer, float, double, url, array or dictionary.
  • domain String (optional) - The domain identifier for an NSUserDefaults suite.

Returns any - The value of key in NSUserDefaults of type type.

Example:

const { getUserDefault } = require('node-mac-userdefaults')

const interfaceStyle = getUserDefault('AppleInterfaceStyle', 'string')

console.log(interfaceStyle) // 'Dark'

defaults.setUserDefault(type, key, value[, domain])

  • type String - Can be string, boolean, integer, float, double, url, array or dictionary.
  • key String - The NSUserDefault to update, e.g AppleInterfaceStyle.
  • value any - The new value to set for key; must match type of type.
  • domain String (optional) - The domain identifier for an NSUserDefaults suite.

Sets the value of key in NSUserDefaults.

Example:

const { setUserDefault } = require('node-mac-userdefaults')

setUserDefault('boolean', 'ApplePressAndHoldEnabled', true)

Note: NSGlobalDomain is an invalid domain name because it isn't writeable by apps.

defaults.removeUserDefault(key[, domain])

  • key String - The NSUserDefault to remove, e.g AppleInterfaceStyle.
  • domain String (optional) - The domain identifier for an NSUserDefaults suite.

Removes the key in NSUserDefaults.

This can be used to restore the default or global value of a key previously set with setUserDefault.

Example:

const { removeUserDefault } = require('node-mac-userdefaults')

removeUserDefault('ApplePressAndHoldEnabled')

Note: NSGlobalDomain is an invalid domain name because it isn't writeable by apps.

defaults.isKeyManaged(key[, domain])

  • key String - The NSUserDefault to check, e.g AppleInterfaceStyle.
  • domain String (optional) - The domain identifier for an NSUserDefaults suite.

Returns a Boolean value indicating whether the specified key is managed by an administrator.

Example:

const { isKeyManaged } = require('node-mac-userdefaults')

const managed = isKeyManaged('ApplePressAndHoldEnabled')

console.log(managed) // false

defaults.addDomain(name)

  • name String - The name of the domain to insert into the user’s domain hierarchy.

Inserts the specified domain name into the user’s domain hierarchy.

Example:

const { addDomain } = require('node-mac-userdefaults')

addDomain('DomainForMyApp')

defaults.removeDomain(name)

  • name String - The name of the domain to remove from the user’s domain hierarchy.

Removed the specified domain name into the user’s domain hierarchy.

Example:

const { removeDomain } = require('node-mac-userdefaults')

removeDomain('DomainForMyApp')

Note: Passing NSGlobalDomain is unsupported.

FAQ

What are domains?

The NSUserDefaults database consists of a hierarchy of domains. Whenever you read the value for a given key, NSUserDefaults traverses this hierarchy from top to bottom and returns the first value it finds. These domains can be either persistent (stored on disk) or volatile (only valid for the lifetime of the NSUserDefaults instance).

Domain Name Description State
NSArgumentDomain The domain consisting of defaults parsed from the application’s arguments volatile
NSGlobalDomain The domain consisting of defaults meant to be seen by all applications persistent
NSRegistrationDomain The domain consisting of a set of temporary defaults whose values can be set by the application to ensure that searches will always be successful volatile

You can also specify custom domains to store a set of preferences.