# fast-plist

> A fast PLIST parser

Latest version **0.1.3** (published 2022-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install fast-plist
pnpm add fast-plist
yarn add fast-plist
bun add fast-plist
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2022-11-22 |
| First published | 2016-08-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 42 |
| Author | Microsoft Corporation |
| Maintainers | alexandrudima, joaomoreno.ms, lszomoru, vscode-bot |

## Links

- npm: https://www.npmjs.com/package/fast-plist
- Repository: https://github.com/Microsoft/node-fast-plist
- Homepage: https://github.com/Microsoft/node-fast-plist#readme
- Issues: https://github.com/Microsoft/node-fast-plist/issues
- npm.io page: https://npm.io/package/fast-plist

## Recent versions

- 0.1.3 (latest) — 2022-11-22
- 0.1.2 — 2016-09-10
- 0.1.1 — 2016-08-17
- 0.1.0 — 2016-08-17

## README

# fast-plist [![Build Status](https://dev.azure.com/ms/node-fast-plist/_apis/build/status/microsoft.node-fast-plist?branchName=master)](https://dev.azure.com/ms/node-fast-plist/_build/latest?definitionId=139&branchName=master)
A fast PLIST parser.


## Installing

```sh
npm install fast-plist
```

## Using

```javascript
var parse = require('fast-plist').parse;

console.log(
    parse(`
        <?xml version="1.0" encoding="UTF-8"?>
        <plist version="1.0">
        <dict>
            <key>name</key>
            <string>Brogrammer</string>
            <key>settings</key>
            <dict>
                <key>background</key>
                <string>#1a1a1a</string>
                <key>caret</key>
                <string>#ecf0f1</string>
                <key>foreground</key>
                <string>#ecf0f1</string>
                <key>invisibles</key>
                <string>#F3FFB51A</string>
                <key>lineHighlight</key>
                <string>#2a2a2a</string>
            </dict>
        </dict>
        </plist>`
    )
);
/* Output:
{
        "name": "Brogrammer",
        "settings": {
                "background": "#1a1a1a",
                "caret": "#ecf0f1",
                "foreground": "#ecf0f1",
                "invisibles": "#F3FFB51A",
                "lineHighlight": "#2a2a2a"
        }
}
*/
```

```javascript

parse(`bad string`);

/* Output:

Error: Near offset 1: expected < ~~~ad string~~~
*/
```

## Development

* `npm run watch`
* `npm run test`

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.


## License
[MIT](https://github.com/Microsoft/node-fast-plist/blob/master/LICENSE.md)

---
_Source: https://npm.io/package/fast-plist · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._