# js-crdt

> CRDT Conflict-free Replication Data Type

Latest version **1.0.0** (published 2017-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install js-crdt
pnpm add js-crdt
yarn add js-crdt
bun add js-crdt
```

## 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 | 2017-07-25 |
| First published | 2017-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 72 |
| Author | Gabriel Habryn |
| Maintainers | widmogrod |
| Keywords | crdt |

## Links

- npm: https://www.npmjs.com/package/js-crdt
- Repository: https://github.com/widmogrod/js-crdt
- Homepage: https://github.com/widmogrod/js-crdt#readme
- Issues: https://github.com/widmogrod/js-crdt/issues
- npm.io page: https://npm.io/package/js-crdt

## Recent versions

- 1.0.0 (latest) — 2017-07-25
- 1.7.1 (next) — 2017-11-27
- 1.6.0 — 2017-09-18
- 1.5.4 — 2017-09-17
- 1.5.3 — 2017-09-17
- 1.5.2 — 2017-09-16
- 1.4.0 — 2017-09-12
- 1.3.5 — 2017-09-02
- 1.3.4 — 2017-09-02
- 1.3.3 — 2017-09-02
- 1.3.2 — 2017-08-29
- 1.3.1 — 2017-08-28
- 1.1.1 — 2017-08-13

## README

# js-crdt [![Build Status](https://travis-ci.org/widmogrod/js-crdt.svg?branch=master)](https://travis-ci.org/widmogrod/js-crdt)
## Introduction
CRDT Conflict-free Replication Data Type in JavaScript.

## Development
```
npm install
npm run build
npm test
npm run lint
npm run dist
```

## How `crdt/Text` type with `order/discrete` should work? (WIP)
Consider two actors `a` and `b` working concurrently on some document.
Actor `a` and `b` have __same origin__ of the document `origin:0`.
For simplification, origin is not shown here.

```
a:0
b:0
```

First actor started working on version `a:0`, and did some changes `xxx`.
Actor `b` did not start working on document.
```
a:0  xxx
b:0
```

Actor `a` decided to send his version `a:1` to actor `b`,
but before that, he want to be sure that regardless if `b` receives his changes, he can continue on working his version of document.
so he created a snapshot `a:1` of his version of document and send changes to actor `b`.

```
a:0  xxx  a:1
b:0
```

Actor `b` sees incoming changes `a:0` of the actor `a`,
so he merge them with his current state and create new version it `b:1 a:0`
```
a:0  xxx  a:1
            |
b:0      b:1 a:0
```

Actor `b` decides to add something to document `yyy`, and send his changes to actor `a`.
Actor `b` in the same manner, before sending his changes to actor `a`
he creates snapshot of his version of document `b:2 a:0` and send changes `b:1 a:0` to `a`.

```
a:0  xxx  a:1
            |
b:0      b:1 a:0  yyy  b:2 a:0
```

When actor `a` sees incoming changes, he merge them with his document.
```
a:0  xxx  a:1          a:2 b:1
            |             |
b:0      b:1 a:0  yyy  b:2 a:0
```

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