# leveldown-hyper

> A Node.js LevelDB binding, primary backend for LevelUP (HyperDex fork)

Latest version **2.0.0** (published 2018-06-21) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install leveldown-hyper
pnpm add leveldown-hyper
yarn add leveldown-hyper
bun add leveldown-hyper
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-06-21 |
| First published | 2013-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 2.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 16 |
| Maintainers | hij1nx, juliangruber, ralphtheninja, rvagg, vweevers |
| Keywords | leveldb, level |

## Links

- npm: https://www.npmjs.com/package/leveldown-hyper
- Repository: https://github.com/level/leveldown-hyper
- Issues: https://github.com/level/leveldown-hyper/issues
- npm.io page: https://npm.io/package/leveldown-hyper

## Dependencies (5)

- [nan](https://npm.io/package/nan.md) ^2.6.2
- [bindings](https://npm.io/package/bindings.md) ~1.3.0
- [fast-future](https://npm.io/package/fast-future.md) ~1.0.0
- [prebuild-install](https://npm.io/package/prebuild-install.md) ^2.2.2
- [abstract-leveldown](https://npm.io/package/abstract-leveldown.md) ~5.0.0

## Recent versions

- 2.0.0 (latest) — 2018-06-21
- 1.0.0-0 (next) — 2015-05-16
- 1.1.3 — 2017-08-15
- 1.1.3-0 — 2017-08-15
- 1.1.2 — 2017-06-05
- 1.1.1 — 2016-04-19
- 1.1.0 — 2015-09-23
- 1.0.0 — 2015-05-19
- 0.10.5 — 2015-05-10
- 0.10.2 — 2014-04-26
- 0.10.1 — 2013-11-21
- 0.10.0 — 2013-11-18
- 0.9.1 — 2013-10-09
- 0.8.2 — 2013-09-02
- 0.8.1 — 2013-09-01
- … 5 more at https://npm.io/package/leveldown-hyper/versions

## README

# leveldown-hyper

[![level badge][level-badge]](https://github.com/level/awesome)
[![npm](https://img.shields.io/npm/v/leveldown-hyper.svg)](https://www.npmjs.com/package/leveldown-hyper)
[![Build Status](https://img.shields.io/travis/Level/leveldown-hyper.svg)](http://travis-ci.org/Level/leveldown-hyper)
[![dependencies](https://david-dm.org/Level/leveldown-hyper.svg)](https://david-dm.org/level/leveldown-hyper)
[![npm](https://img.shields.io/npm/dm/leveldown-hyper.svg)](https://www.npmjs.com/package/leveldown-hyper)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

`leveldown-hyper` is a fork of `leveldown` and uses [`HyperLevelDB`](https://github.com/rescrv/HyperLevelDB) as backend. It extends the `leveldown` api with functionality to do live backups. This README only documents the `liveBackup()` method. For a complete reference we refer to [`leveldown`](https://github.com/Level/leveldown).

`leveldown` can be considered an upstream repository to `leveldown-hyper` and any common logic and bug fixes will be merged from upstream into this repository.

**If you are upgrading:** please see [UPGRADING.md](UPGRADING.md).

### `db.liveBackup(name, callback)`

<code>liveBackup()</code> is an instance method on an existing database object, used to make a live backup of the current state of the database.

The `name` parameter is a `String`. A successful live backup will result in a backup folder named `backup-:name` inside the `location` folder of the current database.

The `callback` function will be called with no arguments when a live backup was successful, or with a single `error` argument if the backup operation failed for any reason.

## Community

`leveldown-hyper` is an **OPEN Open Source Project**. This means that:

> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the [contribution guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.

## License

[MIT](./LICENSE.md) © 2012-present [Contributors](./CONTRIBUTORS.md).

_`leveldown-hyper` builds on the excellent work of the [`HyperLevelDB`](https://github.com/rescrv/HyperLevelDB) team and the LevelDB and Snappy teams from Google and additional contributors. HyperLevelDB, LevelDB and Snappy are issued under the [New BSD Licence](http://opensource.org/licenses/BSD-3-Clause)._

[level-badge]: http://leveldb.org/img/badge.svg

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