Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jhermsmeier/node-apple-plist

Apple Property List (plist) parsing & serializing
https://github.com/jhermsmeier/node-apple-plist

apple bplist file-format mac macos plist property-list

Last synced: 17 days ago
JSON representation

Apple Property List (plist) parsing & serializing

Host: GitHub
URL: https://github.com/jhermsmeier/node-apple-plist
Owner: jhermsmeier
License: mit
Created: 2018-10-06T15:00:46.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2022-05-26T02:29:38.000Z (over 2 years ago)
Last Synced: 2024-04-25T12:44:52.439Z (7 months ago)
Topics: apple, bplist, file-format, mac, macos, plist, property-list
Language: JavaScript
Size: 72.3 KB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Apple Property List (plist)

[![npm](https://flat.badgen.net/npm/v/apple-plist)](https://npmjs.com/package/apple-plist)

[![npm license](https://flat.badgen.net/npm/license/apple-plist)](https://npmjs.com/package/apple-plist)

[![npm downloads](https://flat.badgen.net/npm/dm/apple-plist)](https://npmjs.com/package/apple-plist)

[![build status](https://flat.badgen.net/travis/jhermsmeier/node-apple-plist/master)](https://travis-ci.org/jhermsmeier/node-apple-plist)

Apple Property List (plist) parsing & serializing of XML / Binary / JSON formats

## Install via [npm](https://npmjs.com)

```sh

$ npm install --save apple-plist

```

## Usage

```js

var Plist = require( 'apple-plist' )

```

```js

var plist = Plist.parse( value )

```

## API

_class_ **Plist**

- **Static Methods:**

    - .parse( **value:** `String` | `Buffer`, **offset:** `Number = 0` ) -> `Plist`

    - .fromJSON( **value:** `String` | `Buffer` | `Object` ) -> `Plist`

- **Instance Properties:**

    - .data -> `Object`

- **Instance Methods:**

    - .parse( **value:** `String` | `Buffer`, **offset:** `Number = 0` ) -> `Plist`

    - .parseXML( **value:** `String` | `Buffer`, **offset:** `Number = 0` ) -> `Plist`

    - .parseBinary( **value:** `Buffer`, **offset:** `Number = 0` ) -> `Plist`

    - .fromJSON( **value:** `String` | `Buffer` | `Object` ) -> `Plist`

    - .write( **buffer:** `Buffer = null`, **offset:** `Number = 0`, **encoding:** `String( 'binary' | 'xml' | 'json' )` ) -> `Buffer`

    - .toString() -> `String`