# bplist-creator

> Binary Mac OS X Plist (property list) creator.

Latest version **0.3.0** (published 2026-09-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install bplist-creator
pnpm add bplist-creator
yarn add bplist-creator
bun add bplist-creator
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2026-09-05 |
| First published | 2013-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=20.19.0 |
| Dependencies | 1 |
| Unpacked size | 80.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 22 |
| Author | Joe Ferner |
| Maintainers | joeferner |
| Keywords | bplist, plist, creator |

## Links

- npm: https://www.npmjs.com/package/bplist-creator
- Repository: https://github.com/joeferner/node-bplist-creator
- Homepage: https://github.com/joeferner/node-bplist-creator#readme
- Issues: https://github.com/joeferner/node-bplist-creator/issues
- npm.io page: https://npm.io/package/bplist-creator

## Dependencies (1)

- [stream-buffers](https://npm.io/package/stream-buffers.md) 3.0.x

## Recent versions

- 0.3.0 (latest) — 2026-09-05
- 0.1.1 — 2022-05-03
- 0.1.0 — 2021-03-08
- 0.0.8 — 2019-05-13
- 0.0.7 — 2016-09-04
- 0.0.6 — 2015-07-27
- 0.0.5 — 2015-03-13
- 0.0.4 — 2014-05-23
- 0.0.3 — 2014-01-07
- 0.0.2 — 2013-04-28

## README

bplist-creator
==============

[![CI](https://github.com/joeferner/node-bplist-creator/actions/workflows/ci.yml/badge.svg)](https://github.com/joeferner/node-bplist-creator/actions/workflows/ci.yml)

Binary Mac OS X Plist (property list) creator.

## Installation

```bash
$ npm install bplist-creator
```

## Quick Examples

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

```javascript
// ESM
import bplist from 'bplist-creator';

const buffer = bplist({
  key1: [1, 2, 3]
});
```

```javascript
// CommonJS
const bplist = require('bplist-creator');

const buffer = bplist({
  key1: [1, 2, 3]
});
```

## Real/Double/Float handling

Javascript don't have different types for `1` and `1.0`. This package
will automatically store numbers as the appropriate type, but can't
detect floats that is also integers.

If you need to force a value to be written with the `real` type pass
an instance of `Real`.

```javascript
// ESM: import bplist, { Real } from 'bplist-creator';
// CommonJS: Real is also available as bplist.Real
const buffer = bplist({
  backgroundRed: new Real(1),
  backgroundGreen: new Real(0),
  backgroundBlue: new Real(0)
});
```

In `xml` the corresponding tags is `<integer>` and `<real>`.

## 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.

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