Type alias MergeParams

Type declaration

• dir: string

  The working tree directory path.

• fs: FsClient

  A file system client.

• theirs: string

  The branch to be merged.

• Optional author?: Author

  Passed to commit when creating a merge commit.

• Optional cache?: Cache

  A cache object.

• Optional committer?: Author

  Passed to commit when creating a merge commit.

• Optional dryRun?: boolean

  If true, simulates a merge so you can test whether it would succeed.

• Optional fastForward?: boolean

  If false, create a merge commit in all cases (default: true).

• Optional fastForwardOnly?: boolean

  If true, then non-fast-forward merges will throw an Error instead of performing a merge.

• Optional gitdir?: string

  The git directory path (default: {dir}/.git).

• Optional message?: string

  Overrides the default auto-generated merge commit message.

• Optional noUpdateBranch?: boolean

  If true, does not update the branch pointer after creating the commit.

• Optional onBlobMerge?: BlobMergeCallback

  Optional blob merge callback.

• Optional onSign?: SignCallback

  A PGP signing implementation.

• Optional ours?: string

  The branch receiving the merge. If undefined, defaults to the current branch.

• Optional signingKey?: string

  Passed to commit when creating a merge commit.