JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4324541
  • Score
    100M100P100Q195670F

Mac OS X Plist parser/builder for NodeJS. Convert a Plist file or string into a native JS object and native JS object into a Plist file.

Package Exports

  • plist

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 (plist) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

node-plist

Provides facilities for reading and writing Mac OS X Plist (property list) files. These are often used in programming OS X and iOS applications, as well as the iTunes configuration XML file.

Plist files represent stored programming "object"s. They are very similar to JSON. A valid Plist file is representable as a native JavaScript Object and vice-versa.

Tests

npm test

Usage

Parsing a plist from filename

var plist = require('plist');

var obj = plist.parseFileSync('myPlist.plist');
console.log(JSON.stringify(obj));

Parsing a plist from string payload

var plist = require('plist');

var obj = plist.parseStringSync('<plist><string>Hello World!</string></plist>');
console.log(obj);  // Hello World!

Given an existing JavaScript Object, you can turn it into an XML document that complies with the plist DTD

var plist = require('plist');

console.log(plist.build({'foo' : 'bar'}).toString());

Deprecated methods

These functions work, but may be removed in a future release. version 0.4.x added Sync versions of these functions.

Parsing a plist from filename

var plist = require('plist');

plist.parseFile('myPlist.plist', function(err, obj) {
  if (err) throw err;

  console.log(JSON.stringify(obj));
});

Parsing a plist from string payload

var plist = require('plist');

plist.parseString('<plist><string>Hello World!</string></plist>', function(err, obj) {
  if (err) throw err;

  console.log(obj[0]);  // Hello World!
});