Package Exports

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

Readme

`simple-plist`

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

Installation

# via npm
npm install simple-plist

# via yarn
yarn add 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));