bplist-parser

bplist-parser

Binary Mac OS X Plist (property list) parser.

Installation

$ npm install bplist-parser

Quick Examples

This package ships both ES module and CommonJS builds, so either import style works.

// ESM
import { parseFile } from 'bplist-parser';

const [obj] = await parseFile('myPlist.bplist');
console.log(JSON.stringify(obj));

// CommonJS
const bplist = require('bplist-parser');

(async () => {
  const [obj] = await bplist.parseFile('myPlist.bplist');
  console.log(JSON.stringify(obj));
})();

parseFileSync and parseBuffer are also exported, and both return an array of the plist's root objects.

Limits

The parser refuses plists that would allocate more than maxObjectSize bytes or contain more than maxObjectCount objects. Both are readable as exports and adjusted through setters:

import { setMaxObjectSize, setMaxObjectCount } from 'bplist-parser';

setMaxObjectSize(200 * 1000 * 1000);
setMaxObjectCount(65536);

Note: before 0.4.0 these were assignable (bplist.maxObjectSize = n). Exported bindings are read-only in both module systems now, so assignment must be replaced with the setters above.

Requirements

Node.js 20.19 or newer.

License

(The MIT License)

Copyright (c) 2012 Near Infinity Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.