# 3-way-merge

> 3-way merging of JavaScript objects

Latest version **0.0.7** (published 2016-06-26) · 0 weekly downloads

## Install

```sh
npm install 3-way-merge
pnpm add 3-way-merge
yarn add 3-way-merge
bun add 3-way-merge
```

## 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.0.7 |
| Published | 2016-06-26 |
| First published | 2014-05-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Maintainers | bender, mark33 |
| Keywords | 3-way merge, 3way merge |

## Links

- npm: https://www.npmjs.com/package/3-way-merge
- Repository: https://github.com/falsecz/3-way-merge
- Issues: https://github.com/falsecz/3-way-merge/issues
- npm.io page: https://npm.io/package/3-way-merge

## Recent versions

- 0.0.7 (latest) — 2016-06-26
- 0.0.6 — 2016-06-26
- 0.0.5 — 2015-08-04
- 0.0.4 — 2015-06-16
- 0.0.3 — 2014-07-02
- 0.0.2 — 2014-05-29
- 0.0.1 — 2014-05-20

## README

[![Build Status](https://travis-ci.org/falsecz/3-way-merge.svg?branch=master)](https://travis-ci.org/falsecz/3-way-merge)
[![Dependency Status](https://david-dm.org/falsecz/3-way-merge.svg)](https://david-dm.org/falsecz/3-way-merge)
[![npm version](https://badge.fury.io/js/3-way-merge.svg)](http://badge.fury.io/js/3-way-merge)


# merge(o, a, b) -> c

3-way merging of JavaScript objects

Takes 3 versions of the same object -- where version 2 and 3 are both derived from version 1 --
and generates a 4th version, effectively merging version 2 and 3 together. When a conflict is
detected (changes made in both version 2 and 3) changes from version 3 are used.

## Prototype

    merge(Object original, Object current, Object new) -> Object

- `original`: Ancestor version (original) from which both `versionA` and `versionB` are derived

- `current`: Version A of `original`

- `new`: Version B of `original`

## Example:

    // The original version which both A and B are derived from
    original = {
        aliases: {
            abc: "Abc"
        },
        deleted: 7890,
        key: "string",
        list: [
            "abc",
            "def"
        ],
        value: 1234
    }

    // Version A
    current = {
        aliases: {
            "abc": "Abcdef",
            "def": "Def"
        },
        list: [
            "abc",
            "cat",
            "def",
            "xyz"
        ],
        value: 123456
    }

    // Version B
    B = {
        aliases: {
            abc: "Abc",
            aab: "Aab"
        },
        list: [
            "abc",
            "zzz"
        ],
        value: 1234
    }

    // --> Merged result
    {
        aliases: {
            abc: "Abcdef",
            aab: "Aab",
            def: "Def"
        },
        list: [
            "abc",
            "cat",
            "xyz",
            "zzz"
        ],
        value: 123456
    }

## Requirements

- `Array.isArray(object) -> Boolean` to be implemented (which it is already in modern JavaScript environments)

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