# apple-data-compression

> Apple Data Compression (ADC) Scheme

Latest version **0.4.1** (published 2018-10-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install apple-data-compression
pnpm add apple-data-compression
yarn add apple-data-compression
bun add apple-data-compression
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2018-10-09 |
| First published | 2017-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonas Hermsmeier |
| Maintainers | jhermsmeier |
| Keywords | apple, adc, udif, disk, image, disk-image, dmg, ndif, compression |

## Links

- npm: https://www.npmjs.com/package/apple-data-compression
- Repository: https://github.com/jhermsmeier/node-apple-data-compression
- Issues: https://github.com/jhermsmeier/node-apple-data-compression/issues
- npm.io page: https://npm.io/package/apple-data-compression

## Dependencies (1)

- [bloodline](https://npm.io/package/bloodline.md) ^1.0.1

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 0.4.1 (latest) — 2018-10-09
- 0.4.0 — 2018-03-07
- 0.3.0 — 2018-03-07
- 0.2.0 — 2017-09-12
- 0.1.0 — 2017-04-07

## README

# Apple Data Compression (ADC) Scheme
[![npm](https://img.shields.io/npm/v/apple-data-compression.svg?style=flat-square)](https://npmjs.com/package/apple-data-compression)
[![npm license](https://img.shields.io/npm/l/apple-data-compression.svg?style=flat-square)](https://npmjs.com/package/apple-data-compression)
[![npm downloads](https://img.shields.io/npm/dm/apple-data-compression.svg?style=flat-square)](https://npmjs.com/package/apple-data-compression)
[![build status](https://img.shields.io/travis/jhermsmeier/node-apple-data-compression/master.svg?style=flat-square)](https://travis-ci.org/jhermsmeier/node-apple-data-compression)

The Apple Data Compression (ADC) scheme relies on both [run-length encoding](https://en.wikipedia.org/wiki/Run-length_encoding)
and pointing to data in a [sliding dictionary](https://en.wikipedia.org/wiki/Dictionary_coder).

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

```sh
$ npm install --save apple-data-compression
```

## Related Modules

- [Apple Universal Disk Image Format](https://github.com/jhermsmeier/node-udif)

## Usage

```js
var adc = require( 'apple-data-compression' )
```

### Sync decompression

```js
var result = adc.decompress( buffer )
```

### Streaming

```js
var transform = new adc.Decompressor()
// OR var transform = adc.createDecompress()

fs.createReadStream( filename )
  .pipe( transform )
  .on( 'data', ( chunk ) => {
    // ...
  })
```

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