Skip to content
A simple API for interacting with binary and plain text plist data.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.gitignore
LICENSE
README.md
package.json
simple-plist.js

README.md

node-simple-plist

A simple API for interacting with binary and plain text plist data.

Installation

$ npm install simple-plist

Reading Data

var plist = require('simple-plist');

// Read data from a file (xml or binary) (asynchronous)
plist.readFile('/path/to/some.plist', function(err,data){
    if (err) {throw err;}
    console.log( JSON.stringify(data) );
});

// Read data from a file (xml or binary) (synchronous)
var data = plist.readFileSync('/path/to/some.plist');
console.log( JSON.stringify(data) );

Writing Data

var plist = require('simple-plist'),
    data = plist.readFileSync('/path/to/some.plist');

// Write data to a xml file (asynchronous)
plist.writeFile('/path/to/plaintext.plist', data, function(err){
    if (err) { throw err; }
});

// Write data to a xml file (synchronous)
plist.writeFileSync('/path/to/plaintext.plist', data);

// Write data to a binary plist file (asynchronous)
plist.writeBinaryFile('/path/to/binary.plist', data, function(err){
    if (err) { throw err; }
});

// Write data to a binary plist file (synchronous)
plist.writeBinaryFileSync('/path/to/binary.plist', data);

Mutating Plists In Memory

var plist = require('simple-plist');

// Convert a Javascript object to a plist xml string
var xml = plist.stringify( {name: "Joe", answer:42} );
console.log(xml); // output is a valid plist xml string

// Convert a plist xml string or a binary plist buffer to a Javascript object
var data = plist.parse("<plist><dict><key>name</key><string>Joe</string></dict></plist>");
console.log( JSON.stringify(data) );
Something went wrong with that request. Please try again.