# level-observed-remove > [![CircleCI](https://circleci.com/gh/wehriam/level-observed-remove.svg?style=svg)](https://circleci.com/gh/wehriam/level-observed-remove) [![npm version](https://badge.fury.io/js/level-observed-remove.svg)](http://badge.fury.io/js/level-observed-remove) [ Latest version **1.0.0** (published 2018-04-13) · MIT license · 0 weekly downloads ## Install ```sh npm install level-observed-remove pnpm add level-observed-remove yarn add level-observed-remove bun add level-observed-remove ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2018-04-13 | | First published | 2018-04-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 563.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | John Wehr | | Maintainers | wehriam | ## Links - npm: https://www.npmjs.com/package/level-observed-remove - Repository: https://github.com/wehriam/level-observed-remove - Homepage: https://github.com/wehriam/level-observed-remove#readme - Issues: https://github.com/wehriam/level-observed-remove/issues - npm.io page: https://npm.io/package/level-observed-remove ## Dependencies (3) - [murmur-hash](https://npm.io/package/murmur-hash.md) ^1.0.0 - [level-directed-graph-map](https://npm.io/package/level-directed-graph-map.md) 1.1.1 - [json-stringify-deterministic](https://npm.io/package/json-stringify-deterministic.md) ^1.0.1 ## Recent versions - 1.0.0 (latest) — 2018-04-13 ## README # LevelDB Observed-Remove Map [![CircleCI](https://circleci.com/gh/wehriam/level-observed-remove.svg?style=svg)](https://circleci.com/gh/wehriam/level-observed-remove) [![npm version](https://badge.fury.io/js/level-observed-remove.svg)](http://badge.fury.io/js/level-observed-remove) [![codecov](https://codecov.io/gh/wehriam/level-observed-remove/branch/master/graph/badge.svg)](https://codecov.io/gh/wehriam/level-observed-remove) Eventually-consistent, conflict-free replicated data types (CRDT) [implemented](https://github.com/wehriam/level-observed-remove/blob/master/src/index.js) using LevelDB. ```js const level = require('level'); const { LevelObservedRemoveMap } = require('level-observed-remove'); const run = async () => { const db = level('./optional-db-path'); const alice = new LevelObservedRemoveMap(); const bob = new LevelObservedRemoveMap(); alice.on('publish', (message) => { setTimeout(() => bob.process(message), Math.round(Math.random() * 1000)); }); bob.on('publish', (message) => { setTimeout(() => alice.process(message), Math.round(Math.random() * 1000)); }); await alice.set('a', 1); await bob.add('b', 2); // Later await alice.get('b'); // 2 await bob.get('a'); // 1 }; run(); ``` ## Install `yarn add level-observed-remove` ## Map API #### Table of Contents - [LevelObservedRemoveMap](#levelobservedremovemap) - [dump](#dump) - [sync](#sync) - [process](#process) - [set](#set) - [get](#get) - [delete](#delete) - [clear](#clear) - [has](#has) - [size](#size) ### LevelObservedRemoveMap **Extends EventEmitter** Class representing a LevelDB Observed Remove Map **Parameters** - `db` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** - `entries` **Iterable<\[K, V]>** - `options` **Options** (optional, default `{}`) #### dump Return an array containing all of the map's insertions and deletions. Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<\[[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<any>, [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<any>]>** #### sync Emit a 'publish' event containing a specified queue or all of the set's insertions and deletions. **Parameters** - `queue` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<any>>** Array of insertions and deletions Returns **void** #### process Process an array of insertion and deletions. **Parameters** - `queue` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<any>>** Array of insertions and deletions - `skipFlush` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** (optional, default `false`) Returns **void** #### set Add or update an element with a specified key and value. **Parameters** - `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The key of the element to add to the object. - `value` **any** The value of the element to add to the object. - `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `generateId()`) Returns **void** #### get Returns a specified element. **Parameters** - `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The key of the element to retrieve. Returns **any** #### delete Remove the specified element. **Parameters** - `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The key of the element to remove. Returns **void** #### clear Removes all elements. Returns **void** #### has Indicates whether an element with the specified key exists **Parameters** - `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The key of the element to check. Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** #### size Number of key-value pairs. Returns **void** --- _Source: https://npm.io/package/level-observed-remove · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._