# @types/plist

> TypeScript definitions for plist

Latest version **3.0.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/plist
pnpm add @types/plist
yarn add @types/plist
bun add @types/plist
```

## Health

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

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.5 |
| Published | 2023-11-07 |
| First published | 2018-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/plist
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/plist
- npm.io page: https://npm.io/package/@types/plist

## Dependencies (2)

- [xmlbuilder](https://npm.io/package/xmlbuilder.md) >=11.0.1
- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 3.0.5 (latest) — 2023-11-07
- 3.0.2 (ts2.2) — 2019-04-16
- 3.0.4 — 2023-10-18
- 3.0.3 — 2023-09-24
- 3.0.1 — 2018-10-29
- 3.0.0 — 2018-09-27

## README

# Installation
> `npm install --save @types/plist`

# Summary
This package contains type definitions for plist (https://github.com/TooTallNate/node-plist#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/plist.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/plist/index.d.ts)
````ts
/// <reference types="node" />
import { XMLToStringOptions } from "xmlbuilder";

// plist
export as namespace plist;

// plist.parse()
export function parse(xml: string): PlistValue;
// plist.build()
export function build(obj: PlistValue, opts?: PlistBuildOptions): string;

// PlistValue
export type PlistValue = string | number | boolean | Date | Buffer | PlistObject | PlistArray;
export interface PlistObject {
    readonly [x: string]: PlistValue;
}
export interface PlistArray extends ReadonlyArray<PlistValue> {}

// PlistBuildOptions
// The instance of this type is passed to 'xmlbuilder' module as it is.
export type PlistBuildOptions = XMLToStringOptions;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [xmlbuilder](https://npmjs.com/package/xmlbuilder)

# Credits
These definitions were written by [Yusuke Higuchi](https://github.com/higuri).

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