Function merge

  • Merge two branches.

    Limitations

    Currently it does not support incomplete merges. That is, if there are merge conflicts it cannot solve with the built in diff3 algorithm it will not modify the working dir, and will throw a MergeNotSupportedError error.

    Currently it will fail if multiple candidate merge bases are found. (It doesn't yet implement the recursive merge strategy.)

    You can use onBlobMerge callback to define your own merge stragegy.

    Returns

    Resolves to a description of the merge operation.

    Example

    const m = await merge({
    fs,
    dir: '/tutorial',
    ours: 'main',
    theirs: 'remotes/origin/main'
    })
    console.log(m)

    Parameters

    Returns Promise<MergeResult>

Generated using TypeDoc